MyBatis 添加元數據自定義元素標簽的實現代碼

更新時間：2020年07月24日 11:07:02 作者：小王886

這篇文章主要介紹了MyBatis 添加元數據自定義元素標簽的實現代碼，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

開發(fā)背景

現有系統(tǒng)中維護了一套業(yè)務表相關列、鍵的元數據，希望通過讀取元數據實現自動封裝 SQL 語句、自定義主鍵策略。實現方案為入侵式修改 MyBatis，增加元素標簽meta，支持業(yè)務開發(fā)中可以在XML映射文件中使用。

meta元素設計如下：

<!-- meta標簽 可根據參數獲取到對應的表名 動態(tài)生成語句 -->
<!ELEMENT meta EMPTY>
<!ATTLIST meta
test CDATA #IMPLIED
type (update|insert|select|columns|pk-col|load|load-columns) #IMPLIED
ignore CDATA #IMPLIED
table CDATA #IMPLIED
func CDATA #IMPLIED
alias CDATA #IMPLIED
>

期望示例如下：

<insert id="insertMap" useGeneratedKeys="true" generator="meta">
 <meta table="USER" type="insert"/>
</insert>

<update id="updateMap">
 <meta table="USER" type="update"/>
</update>

<select id="selectOneByPk" resultType="java.util.HashMap">
 select 
 <meta table="USER" type="columns"/> 
 from USER 
 where <meta table="USER" type="pk-col"/> = #{__PK_VALUE}
</select>

開發(fā)準備

新建項目并引入 mybatis 、 mybatis-spring 兩個核心依賴。

<!-- mybatis -->
<dependency>
 <groupId>org.mybatis</groupId>
 <artifactId>mybatis</artifactId>
</dependency>
<!-- mybatis-spring -->
<dependency>
 <groupId>org.mybatis</groupId>
 <artifactId>mybatis-spring</artifactId>
</dependency>

增加自定義元素

創(chuàng)建 MetaHandler 和 MetaSqlNode

public class MetaHandler implements NodeHandler {

 private final CustomConfiguration configuration;

 protected MetaHandler(CustomConfiguration configuration) {
 this.configuration = configuration;
 }

 @Override
 public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
 final String test = nodeToHandle.getStringAttribute("test");
 final String type = nodeToHandle.getStringAttribute("type");
 final String ignore = nodeToHandle.getStringAttribute("ignore");
 final String table = nodeToHandle.getStringAttribute("table");
 final String func = nodeToHandle.getStringAttribute("func");
 String alias = nodeToHandle.getStringAttribute("alias");
 if (!StringUtils.isEmpty(alias)) {
  alias = alias.trim();
  //是否無效 防止注入
  boolean invalid = alias.contains(" ") || alias.contains(".");
  if (invalid) {
  throw new RuntimeException("alias is invalid : " + alias);
  }
 }
 MetaSqlNode metaSqlNode = new MetaSqlNode(configuration, test, type, ignore, table, func, alias);
 targetContents.add(metaSqlNode);
 }
}

public class MetaSqlNode implements SqlNode {

 /**
 * mybatis核心數據
 */
 private final CustomConfiguration configuration;
 /**
 * 判斷語句校驗器
 */
 private final ExpressionEvaluator evaluator;
 /**
 * 判斷語句,同if標簽
 */
 private final String test;
 /**
 * 生成語句類型 update|insert|select|columns|pk-col|load|load-columns
 */
 private final TypeEnum type;
 /**
 * 忽略的列
 */
 private final String ignore;
 /**
 * 表名，未指定則從調用參數中獲取
 */
 private final String table;
 /**
 * 功能，未指定則從調用參數中獲取
 */
 private final String func;
 /**
 * 動態(tài)列別名
 */
 private final String alias;

 public MetaSqlNode(CustomConfiguration configuration, String test, String type, String ignore, String table, String func, String alias) {
 this.evaluator = new ExpressionEvaluator();
 this.configuration = configuration;
 this.test = test;
 this.type = TypeEnum.parse(type);
 this.ignore = ignore;
 this.table = table;
 this.func = func;
 this.alias = alias;
 }

 @Override
 public boolean apply(DynamicContext context) {
 // TODO 解析type與table，向context中添加語句
 context.appendSql(" insert ······ ");
 }
}

創(chuàng)建 CustomXMLScriptBuilder

內容復制自org.apache.ibatis.scripting.xmltags.XMLScriptBuilder，在 initNodeHandlerMap 方法中添加 MetaHandler。

private void initNodeHandlerMap() {
 nodeHandlerMap.put("trim", new TrimHandler());
 nodeHandlerMap.put("where", new WhereHandler());
 nodeHandlerMap.put("set", new SetHandler());
 nodeHandlerMap.put("foreach", new ForEachHandler());
 nodeHandlerMap.put("if", new IfHandler());
 nodeHandlerMap.put("choose", new ChooseHandler());
 nodeHandlerMap.put("when", new IfHandler());
 nodeHandlerMap.put("otherwise", new OtherwiseHandler());
 nodeHandlerMap.put("bind", new BindHandler());
 //增加元數據標簽解析器
 if (configuration instanceof CustomConfiguration) {
 nodeHandlerMap.put("meta", new MetaHandler((CustomConfiguration) configuration));
 }
}

創(chuàng)建 CustomXMLLanguageDriver

內容復制自org.apache.ibatis.scripting.xmltags.XMLLanguageDriver，在 createSqlSource 方法中使用 CustomXMLScriptBuilder 來解析Xml生成 SqlSource。

@Override
public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
 CustomXMLScriptBuilder builder = new CustomXMLScriptBuilder(configuration, script, parameterType);
 return builder.parseScriptNode();
}

創(chuàng)建 CustomConfiguration

繼承org.apache.ibatis.session.Configuration，內容復制自 Configuration。將構造方法中的 XMLLanguageDriver 修改為 CustomConfiguration。

public CustomConfiguration() {
 
 ······
 
 //默認使用自定義 LanguageDriver
 typeAliasRegistry.registerAlias("XML", CustomXMLLanguageDriver.class);
 
 ······
 
 //默認使用自定義 LanguageDriver
 languageRegistry.setDefaultDriverClass(CustomXMLLanguageDriver.class);
 
 ······
 
}

創(chuàng)建 CustomXMLConfigBuilder

內容復制自org.apache.ibatis.builder.xml.XMLConfigBuilder，支持通過 XML 配置來創(chuàng)建 CustomConfiguration。

public class CustomXMLConfigBuilder extends BaseBuilder {
 
 ······
 
 private CustomXMLConfigBuilder(XPathParser parser, String environment, Properties props) {
 // 使用 CustomConfiguration
 super(new CustomConfiguration());
 ErrorContext.instance().resource("SQL Mapper Configuration");
 this.configuration.setVariables(props);
 this.parsed = false;
 this.environment = environment;
 this.parser = parser;
 }
 
 ······
 
}

創(chuàng)建 SqlSessionFactory

復制自org.mybatis.spring.SqlSessionFactoryBean，將 buildSqlSessionFactory 方法中的 Configuration 替換為 CustomConfiguration。

protected SqlSessionFactory buildSqlSessionFactory() throws Exception {

 final Configuration targetConfiguration;

 CustomXMLConfigBuilder xmlConfigBuilder = null;
 if (this.configuration != null) {
 targetConfiguration = this.configuration;
 if (targetConfiguration.getVariables() == null) {
  targetConfiguration.setVariables(this.configurationProperties);
 } else if (this.configurationProperties != null) {
  targetConfiguration.getVariables().putAll(this.configurationProperties);
 }
 } else if (this.configLocation != null) {
 // 使用 CustomXMLConfigBuilder 創(chuàng)建 CustomConfiguration
 xmlConfigBuilder = new CustomXMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
 targetConfiguration = xmlConfigBuilder.getConfiguration();
 } else {
 LOGGER.debug(
  () -> "Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration");
 // 使用 CustomConfiguration
 targetConfiguration = new CustomConfiguration();
 Optional.ofNullable(this.configurationProperties).ifPresent(targetConfiguration::setVariables);
 }
 
 ······
 
 return this.sqlSessionFactoryBuilder.build(targetConfiguration);
}

修改DTD約束

MyBatis 的約束文件并不支持自定義的 meta 元素，需要使用 CDATA 來處理。示例如下：

<insert id="insertMap" useGeneratedKeys="true" generator="meta">
 <![CDATA[[
 <meta table="USER" type="insert"/>
 ]]>
</insert>

如果不想要 CDATA，則需要通過修改DTD約束來完成。

在 classes 下指定位置添加DTD約束文件org/apache/ibatis/builder/xml/mybatis-3-config.dtd達到覆蓋 MyBatis DTD的效果。
重寫代碼來使用指定 DTD 。

創(chuàng)建 CustomXMLMapperEntityResolver

復制自org.apache.ibatis.builder.xml.XMLMapperEntityResolver，將MYBATIS_MAPPER_DTD修改為指向本地 mybatis-3-mapper.dtd 文件，并在DTD文件中添加 meta 元素的約束。

public class CustomXMLMapperEntityResolver implements EntityResolver {
 
 ······
 
 private static final String MYBATIS_MAPPER_DTD = "com/my/ibatis/builder/xml/mybatis-3-mapper.dtd";
 
 ······
 
}

<!-- meta標簽 可根據參數獲取到對應的表名 動態(tài)生成語句 -->
<!ELEMENT meta EMPTY>
<!ATTLIST meta
test CDATA #IMPLIED
type (update|insert|select|columns|pk-col|load|load-columns) #IMPLIED
ignore CDATA #IMPLIED
table CDATA #IMPLIED
func CDATA #IMPLIED
alias CDATA #IMPLIED
>

CustomXMLLanguageDriver

Mapper動態(tài)語句注解處理使用 CustomXMLMapperEntityResolver。

/**
 * Mapper動態(tài)語句注解調用
 * <p>
 * "<script>select * from user <if test=\"id !=null \">where id = #{id} </if></script>"
 *
 * @param configuration mybatis配置
 * @param script 動態(tài)語句字符串
 * @param parameterType 參數類型
 * @return org.apache.ibatis.mapping.SqlSource
 */
@Override
public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
 // issue #3
 if (script.startsWith("<script>")) {
 //將動態(tài)語句字符串轉換為XNode對象
 XPathParser parser = new XPathParser(script, false, configuration.getVariables(), new CustomXMLMapperEntityResolver());
 return createSqlSource(configuration, parser.evalNode("/script"), parameterType);
 } else {
 // issue #127
 script = PropertyParser.parse(script, configuration.getVariables());
 TextSqlNode textSqlNode = new TextSqlNode(script);
 if (textSqlNode.isDynamic()) {
  return new CustomDynamicSqlSource(configuration, textSqlNode);
 } else {
  return new RawSqlSource(configuration, script, parameterType);
 }
 }
}

創(chuàng)建 CustomXMLMapperBuilder

復制自org.apache.ibatis.builder.xml.XMLMapperBuilder，修改構造函數使用 CustomXMLMapperEntityResolver 解析xml。

public CustomXMLMapperBuilder(InputStream inputStream, Configuration configuration, String resource, Map<String, XNode> sqlFragments) {
 this(new XPathParser(inputStream, true, configuration.getVariables(), new CustomXMLMapperEntityResolver()),
  configuration, resource, sqlFragments);
}

SqlSessionFactory

修改 buildSqlSessionFactory 方法，使用 CustomXMLMapperBuilder 來解析xml。

protected SqlSessionFactory buildSqlSessionFactory() throws Exception {

 ······
 try {
  //使用自定義 XMLMapperBuilder
  CustomXMLMapperBuilder xmlMapperBuilder = new CustomXMLMapperBuilder(mapperLocation.getInputStream(),
   targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());
  xmlMapperBuilder.parse();
 } catch (Exception e) {
  throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
 } finally {
  ErrorContext.instance().reset();
 }
 
 ······
 
}

創(chuàng)建 CustomMapperAnnotationBuilder

復制自org.apache.ibatis.builder.annotation.MapperAnnotationBuilder，修改 loadXmlResource 方法使用 CustomXMLMapperBuilder。

private void loadXmlResource() {
 if (!configuration.isResourceLoaded("namespace:" + type.getName())) {
  
 ······
 
  if (inputStream != null) {
   //使用自定義解析器支持自定義標簽
   CustomXMLMapperBuilder xmlParser = new CustomXMLMapperBuilder(inputStream, assistant.getConfiguration(), xmlResource, configuration.getSqlFragments(), type.getName());
   xmlParser.parse();
  }
 }
}

創(chuàng)建 CustomMapperRegistry

復制自org.apache.ibatis.binding.MapperRegistry，修改 addMapper 方法使用 CustomMapperAnnotationBuilder。

@Override
public <T> void addMapper(Class<T> type) {
 if (type.isInterface()) {
  
 ······
 
  try {
   knownMappers.put(type, new MapperProxyFactory<>(type));
   // It's important that the type is added before the parser is run
   // otherwise the binding may automatically be attempted by the
   // mapper parser. If the type is already known, it won't try.
   CustomMapperAnnotationBuilder parser = new CustomMapperAnnotationBuilder(config, type);
   parser.parse();
   loadCompleted = true;
  } finally {
   if (!loadCompleted) {
    knownMappers.remove(type);
   }
  }
 }
}

CustomConfiguration

修改 mapperRegistry 屬性使用 CustomMapperRegistry。

public class CustomConfiguration extends Configuration {
  
 ······

 protected final MapperRegistry mapperRegistry = new CustomMapperRegistry(this);
  
 ······
 
}

在Spring中使用

<!-- Mybatis SessionFactory-->
<bean id="sqlSessionFactory" class="com.my.ibatis.SqlSessionFactoryBean">
 <property name="dataSource" ref="dataSource" />
 <property name="configurationProperties" >
  <bean class="org.springframework.beans.factory.config.PropertiesFactoryBean">
   <property name="locations" value="classpath*:mybatis.properties"/>
  </bean>
 </property>
</bean>

@Configuration
public class MybatisConfig {
 @Bean
 public PropertiesFactoryBean createPropertiesFactoryBean() throws IOException {
  PropertiesFactoryBean bean = new PropertiesFactoryBean();
  bean.setLocation(new ClassPathResource("mybatis.properties"));
  return bean;
 }

 @Bean("sqlSessionFactory")
 public SqlSessionFactoryBean createSqlSessionFactory(DataSource dataSource, PropertiesFactoryBean bean) throws IOException {
  SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
  factoryBean.setDataSource(dataSource);
  factoryBean.setConfigurationProperties(bean.getObject());
  return factoryBean;
 }
}

到此這篇關于MyBatis 添加元數據自定義元素標簽的實現代碼的文章就介紹到這了,更多相關MyBatis自定義元素標簽內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

JAVA多線程間通訊常用實現方法解析
這篇文章主要介紹了JAVA多線程間通訊常用實現方法解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2020-09-09
java實現利用String類的簡單方法讀取xml文件中某個標簽中的內容
下面小編就為大家?guī)硪黄猨ava實現利用String類的簡單方法讀取xml文件中某個標簽中的內容。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-12-12
Spring AOP注解案例及基本原理詳解
這篇文章主要介紹了Spring AOP注解案例及基本原理詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2020-06-06
詳解Mybatis核心配置文件
今天給大家?guī)淼氖顷P于Java的相關知識,文章圍繞著Mybatis核心配置文件展開,文中有非常詳細的介紹及代碼示例,需要的朋友可以參考下
2021-06-06
深入理解SpringCloud之Eureka注冊過程分析
eureka是一種去中心化的服務治理應用，其顯著特點是既可以作為服務端又可以作為服務向自己配置的地址進行注冊，這篇文章主要介紹了深入理解SpringCloud之Eureka注冊過程分析
2018-05-05
分享40個Java多線程問題小結
多個線程共存于同一JVM進程里面，所以共用相同的內存空間，較之多進程，多線程之間的通信更輕量級,本文給大家分享40個Java多線程問題小結的相關資料,需要的朋友可以參考下
2015-12-12
解決Springboot整合shiro時靜態(tài)資源被攔截的問題
這篇文章主要介紹了解決Springboot整合shiro時靜態(tài)資源被攔截的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2021-01-01
基于springboot的flowable工作流實戰(zhàn)流程分析
這篇文章主要介紹了基于springboot的flowable工作流實戰(zhàn)流程分析,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2021-10-10
Java 實戰(zhàn)圖書管理系統(tǒng)的實現流程
讀萬卷書不如行萬里路，只學書上的理論是遠遠不夠的，只有在實戰(zhàn)中才能獲得能力的提升，本篇文章手把手帶你用java+SSM+jsp+mysql+maven實現一個圖書管理系統(tǒng),大家可以在過程中查缺補漏，提升水平
2021-11-11
SpringBoot加載外部依賴過程解析
這篇文章主要介紹了SpringBoot加載外部依賴過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2020-01-01