Init Check In with modules of Swagger, Entity, Database and Configuration

This commit is contained in:
2024-09-09 19:47:17 +10:00
parent f5aad2d95b
commit dcd7d3c7fb
27 changed files with 674 additions and 3 deletions

36
database/pom.xml Normal file
View File

@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>sydney.cheng</groupId>
<artifactId>ec-microservice-commons</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>ec-microservice-commons-database</artifactId>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>sydney.cheng</groupId>
<artifactId>ec-microservice-commons-configuration</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>com.github.ben-manes.caffeine</groupId>
<artifactId>caffeine</artifactId>
<version>${caffeine.version}</version>
</dependency>
</dependencies>
</project>

View File

@@ -0,0 +1,22 @@
package sydney.cheng.microservice.commons.database.annotation;
import org.springframework.context.annotation.Profile;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Profile("database")
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Transactional("ecTransactionManager")
public @interface DatabaseTransactional {
boolean readOnly() default false;
Propagation propagation() default Propagation.REQUIRED;
Class<? extends Throwable>[] noRollbackFor() default {};
}

View File

@@ -0,0 +1,12 @@
package sydney.cheng.microservice.commons.database.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ReadOnlyConnection {
}

View File

@@ -0,0 +1,52 @@
package sydney.cheng.microservice.commons.database.annotation;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import sydney.cheng.microservice.commons.database.constant.DbType;
import sydney.cheng.microservice.commons.database.datasource.DbContextHolder;
@Aspect
@ToString
@NoArgsConstructor
@Component
public class ReadOnlyConnectionInterceptor implements Ordered {
private int order;
@Override
public int getOrder() {
return order;
}
@Value("20")
public void setOrder(int order) {
this.order = order;
}
/*
* handle interceptor for any public method execution
*/
@Pointcut(value = "execution(public * *(..))")
public void anyPublicMethod() {
throw new UnsupportedOperationException();
}
@Around("@annotation(readOnlyConnection)")
public Object proceed(ProceedingJoinPoint pjp, ReadOnlyConnection readOnlyConnection) throws Throwable {
try {
DbContextHolder.setDbType(DbType.REPLICA);
Object result = pjp.proceed();
DbContextHolder.clearDbType();
return result;
} finally {
// restore state
DbContextHolder.clearDbType();
}
}
}

View File

@@ -0,0 +1,26 @@
package sydney.cheng.microservice.commons.database.config;
import com.github.benmanes.caffeine.cache.Caffeine;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.caffeine.CaffeineCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.TimeUnit;
@EnableCaching
@Configuration
public class CacheManagerConfiguration {
@Bean
public Caffeine<Object, Object> caffeineConfig() {
return Caffeine.newBuilder().expireAfterWrite(12, TimeUnit.HOURS);
}
@Bean
public CacheManager cacheManager(Caffeine<Object, Object> caffeine) {
CaffeineCacheManager caffeineCacheManager = new CaffeineCacheManager();
caffeineCacheManager.setCaffeine(caffeine);
return caffeineCacheManager;
}
}

View File

@@ -0,0 +1,57 @@
package sydney.cheng.microservice.commons.database.config;
import com.zaxxer.hikari.HikariDataSource;
import lombok.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import sydney.cheng.microservice.commons.configuration.properties.database.PrimaryHikariDataSourceProperties;
import sydney.cheng.microservice.commons.configuration.properties.database.ReplicaHikariDataSourceProperties;
import sydney.cheng.microservice.commons.database.constant.DbType;
import sydney.cheng.microservice.commons.database.datasource.RoutingDataSource;
import javax.sql.DataSource;
import java.util.Map;
import static sydney.cheng.microservice.commons.database.constant.DatabaseBeanConstant.*;
@Profile(value = {"database & hikari"})
@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
@Configuration
public class HikariDataSourceConfiguration {
private final PrimaryHikariDataSourceProperties primaryHikariDataSourceProperties;
private final ReplicaHikariDataSourceProperties replicaHikariDataSourceProperties;
@Bean(name = PRIMARY_DS_BEAN_NAME)
public DataSource primaryDataSource() {
if (this.primaryHikariDataSourceProperties == null) throw new AssertionError();
this.primaryHikariDataSourceProperties.setPoolName(PRIMARY_DS_BEAN_NAME);
return new HikariDataSource(this.primaryHikariDataSourceProperties);
}
@Bean(name = REPLICA_DS_BEAN_NAME)
public DataSource replicaDataSource() {
if (this.replicaHikariDataSourceProperties == null) throw new AssertionError();
this.replicaHikariDataSourceProperties.setPoolName(REPLICA_DS_BEAN_NAME);
return new HikariDataSource(this.replicaHikariDataSourceProperties);
}
/**
* Configure data source routing for MRCENTRAL.
*
* @return data source
* @see RoutingDataSource
*/
@Bean(name = {"dataSource", DS_BEAN_NAME})
public DataSource centralDataSource() {
RoutingDataSource rds = new RoutingDataSource();
rds.setTargetDataSources(Map
.of(DbType.PRIMARY, this.primaryDataSource(), DbType.REPLICA, this.replicaDataSource()));
rds.setDefaultTargetDataSource(this.primaryDataSource());
return rds;
}
}

View File

@@ -0,0 +1,70 @@
package sydney.cheng.microservice.commons.database.config;
import jakarta.persistence.EntityManagerFactory;
import org.hibernate.cfg.AvailableSettings;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.orm.hibernate5.SpringBeanContainer;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.orm.jpa.JpaVendorAdapter;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
import sydney.cheng.microservice.commons.configuration.properties.database.DatabaseProperties;
import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;
import static sydney.cheng.microservice.commons.database.constant.DatabaseBeanConstant.*;
@Profile(value = {"database & hikari"})
@Configuration
@EnableJpaRepositories(
basePackages = "sydney.cheng.**.repository",
entityManagerFactoryRef = "entityManagerFactory",
transactionManagerRef = "transactionManager"
)
public class JPAPersistenceConfiguration {
private final ConfigurableListableBeanFactory beanFactory;
private final DatabaseProperties databaseProperties;
public JPAPersistenceConfiguration(
ConfigurableListableBeanFactory beanFactory,
DatabaseProperties databaseProperties
) {
this.beanFactory = beanFactory;
this.databaseProperties = databaseProperties;
}
@Bean
public LocalContainerEntityManagerFactoryBean entityManagerFactory(@Qualifier(DS_BEAN_NAME) DataSource dataSource) {
LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
em.setPersistenceUnitName("persistence-unit");
em.setPackagesToScan(this.databaseProperties.getEntityManager().getPackages());
em.setDataSource(dataSource);
JpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
em.setJpaVendorAdapter(vendorAdapter);
Map<String, Object> properties = new HashMap<>(this.databaseProperties.getJpa().getProperties());
properties.put(AvailableSettings.PHYSICAL_NAMING_STRATEGY, "org.hibernate.boot.model.naming.CamelCaseToUnderscoresNamingStrategy");
properties.put(AvailableSettings.IMPLICIT_NAMING_STRATEGY, "org.springframework.boot.orm.jpa.hibernate.SpringImplicitNamingStrategy");
properties.put(AvailableSettings.BEAN_CONTAINER, new SpringBeanContainer(this.beanFactory));
em.setJpaPropertyMap(properties);
return em;
}
@Bean
public JpaTransactionManager transactionManager(@Qualifier("entityManagerFactory") EntityManagerFactory emf) {
JpaTransactionManager transactionManager = new JpaTransactionManager();
transactionManager.setEntityManagerFactory(emf);
return transactionManager;
}
}

View File

@@ -0,0 +1,10 @@
package sydney.cheng.microservice.commons.database.constant;
import lombok.NoArgsConstructor;
@NoArgsConstructor(access = lombok.AccessLevel.PRIVATE)
public class DatabaseBeanConstant {
public static final String DS_BEAN_NAME = "databaseDataSource";
public static final String PRIMARY_DS_BEAN_NAME = "databaseDataSourcePrimary";
public static final String REPLICA_DS_BEAN_NAME = "databaseDataSourceReplica";
}

View File

@@ -0,0 +1,5 @@
package sydney.cheng.microservice.commons.database.constant;
public enum DbType {
PRIMARY, REPLICA
}

View File

@@ -0,0 +1,27 @@
package sydney.cheng.microservice.commons.database.datasource;
import sydney.cheng.microservice.commons.database.constant.DbType;
public class DbContextHolder {
private static final ThreadLocal<DbType> contextHolder = new ThreadLocal<>();
private DbContextHolder() {
super();
}
public static DbType getDbType() {
return contextHolder.get();
}
public static void setDbType(DbType dbType) {
if (dbType == null) {
throw new NullPointerException();
}
contextHolder.set(dbType);
}
public static void clearDbType() {
contextHolder.remove();
}
}

View File

@@ -0,0 +1,11 @@
package sydney.cheng.microservice.commons.database.datasource;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
public class RoutingDataSource extends AbstractRoutingDataSource {
@Override
protected Object determineCurrentLookupKey() {
return DbContextHolder.getDbType();
}
}