auditing

Author: JARVIS SONG

spring-data-mybatis-core/src/main/java/org/springframework/data/mybatis/domain/AbstractAuditable.java

@@ -33,6 +33,8 @@
  * Abstract base class for auditable entities. Stores the audition values in persistent
  * fields.
  *
+ * @param <PK> primary key type
+ * @param <U> auditor
  * @author JARVIS SONG
  * @since 2.0.1
  */
@@ -66,8 +68,9 @@ public void setCreatedBy(U createdBy) {
 
 	@Override
 	public Optional<LocalDateTime> getCreatedDate() {
-		return null == this.createdDate ? Optional.empty()
-				: Optional.of(LocalDateTime.ofInstant(this.createdDate.toInstant(), ZoneId.systemDefault()));
+		return (null != this.createdDate)
+				? Optional.of(LocalDateTime.ofInstant(this.createdDate.toInstant(), ZoneId.systemDefault()))
+				: Optional.empty();
 	}
 
 	@Override
@@ -87,8 +90,9 @@ public void setLastModifiedBy(U lastModifiedBy) {
 
 	@Override
 	public Optional<LocalDateTime> getLastModifiedDate() {
-		return null == this.lastModifiedDate ? Optional.empty()
-				: Optional.of(LocalDateTime.ofInstant(this.lastModifiedDate.toInstant(), ZoneId.systemDefault()));
+		return (null != this.lastModifiedDate)
+				? Optional.of(LocalDateTime.ofInstant(this.lastModifiedDate.toInstant(), ZoneId.systemDefault()))
+				: Optional.empty();
 	}
 
 	@Override

spring-data-mybatis-core/src/main/java/org/springframework/data/mybatis/domain/AbstractPersistable.java

@@ -31,6 +31,7 @@
  * auto-generation and implements {@link #equals(Object)} and {@link #hashCode()} based on
  * that id.
  *
+ * @param <PK> primary key type
  * @author JARVIS SONG
  * @since 2.0.1
  */
@@ -59,39 +60,31 @@ public boolean isNew() {
 		return null == this.getId();
 	}
 
-	@Override
-	public String toString() {
-		return String.format("Entity of type %s with id: %s", this.getClass().getName(), this.getId());
-	}
-
 	@Override
 	public boolean equals(Object obj) {
-
 		if (null == obj) {
 			return false;
 		}
-
 		if (this == obj) {
 			return true;
 		}
-
 		if (!this.getClass().equals(ProxyUtils.getUserClass(obj))) {
 			return false;
 		}
-
 		AbstractPersistable<?> that = (AbstractPersistable<?>) obj;
-
 		return null != this.getId() && this.getId().equals(that.getId());
 	}
 
 	@Override
 	public int hashCode() {
-
 		int hashCode = 17;
-
-		hashCode += null == this.getId() ? 0 : this.getId().hashCode() * 31;
-
+		hashCode += (null != this.getId()) ? this.getId().hashCode() * 31 : 0;
 		return hashCode;
 	}
 
+	@Override
+	public String toString() {
+		return String.format("Entity of type %s with id: %s", this.getClass().getName(), this.getId());
+	}
+
 }

spring-data-mybatis-core/src/main/java/org/springframework/data/mybatis/domain/Audit.java

@@ -24,7 +24,9 @@
 import javax.persistence.TemporalType;
 
 import lombok.Data;
+import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
+import lombok.ToString;
 
 import org.springframework.data.annotation.CreatedBy;
 import org.springframework.data.annotation.CreatedDate;
@@ -40,6 +42,8 @@
  * @since 2.0.0
  */
 @Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
 @NoArgsConstructor
 @MappedSuperclass
 public abstract class Audit<AUDITOR, ID extends Serializable> extends Id<ID> {

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/dialect/Dialect.java

@@ -33,8 +33,6 @@
 public abstract class Dialect {
 
 	protected Dialect() {
-		log.info("Using dialect: {}", this);
-
 	}
 
 	/**

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/domain/support/AuditingEntityListener.java

@@ -27,24 +27,21 @@
 import org.apache.ibatis.plugin.Invocation;
 import org.apache.ibatis.plugin.Signature;
 
-import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.data.mybatis.repository.support.ResidentParameterName;
 
 /**
- * .
+ * Mybatis interceptor of auditing.
  *
  * @author JARVIS SONG
+ * @since 2.0.1
  */
-@Intercepts({ @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }), })
+@Intercepts({ @Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
 public class AuditingInterceptor implements Interceptor {
 
-	private MybatisAuditingHandler handler;
+	private final MybatisAuditingHandler handler;
 
-	public AuditingInterceptor(ObjectFactory<MybatisAuditingHandler> auditingHandler) {
-
-		if (null != auditingHandler) {
-			this.handler = auditingHandler.getObject();
-		}
+	public AuditingInterceptor(MybatisAuditingHandler auditingHandler) {
+		this.handler = auditingHandler;
 	}
 
 	@Override

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/domain/support/AuditingInterceptor.java

@@ -22,11 +22,13 @@
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.context.MappingContext;
 import org.springframework.data.mapping.context.PersistentEntities;
+import org.springframework.util.Assert;
 
 /**
- * .
+ * Mybatis auditing handler.
  *
  * @author JARVIS SONG
+ * @since 2.0.1
  */
 public class MybatisAuditingHandler extends AuditingHandler {
 
@@ -45,7 +47,11 @@ public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
 		this.sqlSessionTemplate = sqlSessionTemplate;
 	}
 
-	public SqlSessionTemplate getSqlSessionTemplate() {
-		return sqlSessionTemplate;
+	@Override
+	public void afterPropertiesSet() {
+		super.afterPropertiesSet();
+		Assert.notNull(this.sqlSessionTemplate, "SqlSessionTemplate must not be null!");
+		this.sqlSessionTemplate.getConfiguration().addInterceptor(new AuditingInterceptor(this));
 	}
+
 }

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/domain/support/MybatisAuditingHandler.java

@@ -17,28 +17,44 @@
 
 import org.w3c.dom.Element;
 
-import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.xml.BeanDefinitionParser;
-import org.springframework.beans.factory.xml.ParserContext;
 import org.springframework.data.auditing.config.AuditingHandlerBeanDefinitionParser;
+import org.springframework.data.mapping.context.MappingContext;
+import org.springframework.data.mybatis.domain.support.MybatisAuditingHandler;
+import org.springframework.util.StringUtils;
 
 /**
  * {@link BeanDefinitionParser} for the {@code auditing} element.
  *
  * @author JARVIS SONG
  * @since 2.0.0
  */
-public class AuditingBeanDefinitionParser implements BeanDefinitionParser {
+public class AuditingBeanDefinitionParser extends AuditingHandlerBeanDefinitionParser {
+
+	/**
+	 * Creates a new {@link AuditingHandlerBeanDefinitionParser} to point to a
+	 * {@link MappingContext} with the given bean name.
+	 * @param mappingContextBeanName must not be {@literal null} or empty.
+	 */
+	public AuditingBeanDefinitionParser(String mappingContextBeanName) {
+		super(mappingContextBeanName);
+	}
 
-	private final AuditingHandlerBeanDefinitionParser auditingHandlerParser = new AuditingHandlerBeanDefinitionParser(
-			BeanDefinitionNames.MYBATIS_MAPPING_CONTEXT_BEAN_NAME);
+	@Override
+	protected Class<?> getBeanClass(Element element) {
+		return MybatisAuditingHandler.class;
+	}
 
 	@Override
-	public BeanDefinition parse(Element element, ParserContext parser) {
+	protected void doParse(Element element, BeanDefinitionBuilder builder) {
+		super.doParse(element, builder);
 
-		this.auditingHandlerParser.parse(element, parser);
+		String sqlSessionTemplateRef = element.getAttribute("sql-session-template-ref");
 
-		return null;
+		if (StringUtils.hasText(sqlSessionTemplateRef)) {
+			builder.addPropertyReference("sqlSessionTemplate", sqlSessionTemplateRef);
+		}
 	}
 
 }

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/repository/config/AuditingBeanDefinitionParser.java

@@ -42,32 +42,36 @@
 	/**
 	 * Configures the {@link AuditorAware} bean to be used to lookup the current
 	 * principal.
-	 * @return
+	 * @return reference of {@link AuditorAware}
 	 */
 	String auditorAwareRef() default "";
 
 	/**
 	 * Configures whether the creation and modification dates are set. Defaults to
 	 * {@literal true}.
-	 * @return
+	 * @return result
 	 */
 	boolean setDates() default true;
 
 	/**
 	 * Configures whether the entity shall be marked as modified on creation. Defaults to
 	 * {@literal true}.
-	 * @return
+	 * @return result
 	 */
 	boolean modifyOnCreate() default true;
 
 	/**
 	 * Configures a {@link DateTimeProvider} bean name that allows customizing the
 	 * {@link org.joda.time.DateTime} to be used for setting creation and modification
 	 * dates.
-	 * @return
+	 * @return result
 	 */
 	String dateTimeProviderRef() default "";
 
+	/**
+	 * The reference of sqlSessionTemplate.
+	 * @return result
+	 */
 	String sqlSessionTemplateRef() default "";
 
 }

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/repository/config/EnableMybatisAuditing.java

@@ -18,9 +18,10 @@
 import org.springframework.data.auditing.config.AuditingConfiguration;
 
 /**
- * .
+ * MybatisAuditingConfiguration.
  *
  * @author JARVIS SONG
+ * @since 2.0.1
  */
 public interface MybatisAuditingConfiguration extends AuditingConfiguration {
 

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/repository/config/MybatisAuditingConfiguration.java

@@ -25,8 +25,6 @@
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.data.auditing.config.AuditingBeanDefinitionRegistrarSupport;
 import org.springframework.data.auditing.config.AuditingConfiguration;
-import org.springframework.data.config.ParsingUtils;
-import org.springframework.data.mybatis.domain.support.AuditingEntityListener;
 import org.springframework.data.mybatis.domain.support.MybatisAuditingHandler;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
@@ -36,7 +34,6 @@
  * annotation.
  *
  * @author JARVIS SONG
- * @since 2.0.1
  */
 class MybatisAuditingRegistrar extends AuditingBeanDefinitionRegistrarSupport {
 
@@ -57,20 +54,6 @@ protected void registerAuditListenerBeanDefinition(BeanDefinition auditingHandle
 			registry.registerBeanDefinition(BeanDefinitionNames.MYBATIS_MAPPING_CONTEXT_BEAN_NAME, //
 					new RootBeanDefinition(MybatisMappingContextFactoryBean.class));
 		}
-
-		BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(AuditingEntityListener.class);
-		builder.addPropertyValue("auditingHandler",
-				ParsingUtils.getObjectFactoryBeanDefinition(this.getAuditingHandlerBeanName(), null));
-		this.registerInfrastructureBeanWithId(builder.getRawBeanDefinition(), AuditingEntityListener.class.getName(),
-				registry);
-	}
-
-	@Override
-	public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
-		Assert.notNull(annotationMetadata, "AnnotationMetadata must not be null!");
-		Assert.notNull(registry, "BeanDefinitionRegistry must not be null!");
-
-		super.registerBeanDefinitions(annotationMetadata, registry);
 	}
 
 	@Override

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/repository/config/MybatisAuditingRegistrar.java

@@ -30,7 +30,8 @@ public void init() {
 		RepositoryBeanDefinitionParser repositoryBeanDefinitionParser = new RepositoryBeanDefinitionParser();
 
 		registerBeanDefinitionParser("repositories", repositoryBeanDefinitionParser);
-		registerBeanDefinitionParser("auditing", new AuditingBeanDefinitionParser());
+		registerBeanDefinitionParser("auditing",
+				new AuditingBeanDefinitionParser(BeanDefinitionNames.MYBATIS_MAPPING_CONTEXT_BEAN_NAME));
 	}
 
 }

spring-data-mybatis/src/main/java/org/springframework/data/mybatis/repository/config/MybatisRepositoryNameSpaceHandler.java

@@ -81,17 +81,15 @@ abstract class AbstractMybatisPrecompiler implements MybatisPrecompiler {
 	AbstractMybatisPrecompiler(MybatisMappingContext mappingContext, Configuration configuration,
 			RepositoryInformation repositoryInformation) {
 
-		this(mappingContext, configuration, repositoryInformation.getRepositoryInterface().getName(),
-				repositoryInformation.getDomainType());
+		this(mappingContext, configuration, repositoryInformation.getDomainType());
 
 		this.repositoryInterface = repositoryInformation.getRepositoryInterface();
 	}
 
-	AbstractMybatisPrecompiler(MybatisMappingContext mappingContext, Configuration configuration, String namespace,
-			Class<?> domainType) {
+	AbstractMybatisPrecompiler(MybatisMappingContext mappingContext, Configuration configuration, Class<?> domainType) {
 		this.mappingContext = mappingContext;
 		this.configuration = configuration;
-		this.namespace = namespace;
+		this.namespace = domainType.getName();
 		this.persistentEntity = mappingContext.getRequiredPersistentEntity(domainType);
 		this.dialect = StandardDialectResolver.INSTANCE.resolveDialect(
 				new DatabaseMetaDataDialectResolutionInfoAdapter(configuration.getEnvironment().getDataSource()));