2. 程式人生 > >mybatis-generator擴充套件教程系列 -- 自定義generatorConfig.xml引數

mybatis-generator擴充套件教程系列 -- 自定義generatorConfig.xml引數

阿新 • • 發佈：2018-12-30

        今天我打算講如何在生成器的xml配置檔案里加入自定義的引數,真實很多場景我們會遇到需要自定義BaseDAO,BaseService類路徑,所以這個時候為了擴充套件我們會考慮把這些引數放到xml配置,下面就延續使用上一篇的教程專案來做程式碼示例(如果沒有看過之前的環境搭建入門篇可以到文章目錄點選進入)

1.大家可以先直接開啟MyBatisGeneratorConfigurationParser.java這個類,其中下面兩段程式碼即是讀取xml配置的節點並填充到Context物件(,我們可以在這裡照著模版加入自己的資料節點)

private void parseContext(Configuration configuration, Node node) {

        Properties attributes = parseAttributes(node);
        String defaultModelType = attributes.getProperty("defaultModelType"); //$NON-NLS-1$
        String targetRuntime = attributes.getProperty("targetRuntime"); //$NON-NLS-1$
        String introspectedColumnImpl = attributes
                .getProperty("introspectedColumnImpl"); //$NON-NLS-1$
        String id = attributes.getProperty("id"); //$NON-NLS-1$

        ModelType mt = defaultModelType == null ? null : ModelType
                .getModelType(defaultModelType);

        Context context = new Context(mt);
        context.setId(id);
        if (stringHasValue(introspectedColumnImpl)) {
            context.setIntrospectedColumnImpl(introspectedColumnImpl);
        }
        if (stringHasValue(targetRuntime)) {
            context.setTargetRuntime(targetRuntime);
        }

        configuration.addContext(context);

        NodeList nodeList = node.getChildNodes();
        for (int i = 0; i < nodeList.getLength(); i++) {
            Node childNode = nodeList.item(i);

            if (childNode.getNodeType() != Node.ELEMENT_NODE) {
                continue;
            }

            if ("property".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseProperty(context, childNode);
            } else if ("plugin".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parsePlugin(context, childNode);
            } else if ("commentGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseCommentGenerator(context, childNode);
            } else if ("jdbcConnection".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJdbcConnection(context, childNode);
            } else if ("connectionFactory".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseConnectionFactory(context, childNode);
            } else if ("javaModelGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaModelGenerator(context, childNode);
            } else if ("javaTypeResolver".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaTypeResolver(context, childNode);
            } else if ("sqlMapGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseSqlMapGenerator(context, childNode);
            } else if ("javaClientGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaClientGenerator(context, childNode);
            } else if ("table".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseTable(context, childNode);
            }
        }
    }
 

private void parseJavaClientGenerator(Context context, Node node) {
        JavaClientGeneratorConfiguration javaClientGeneratorConfiguration = new JavaClientGeneratorConfiguration();

        context.setJavaClientGeneratorConfiguration(javaClientGeneratorConfiguration);

        Properties attributes = parseAttributes(node);
        String type = attributes.getProperty("type"); //$NON-NLS-1$
        String targetPackage = attributes.getProperty("targetPackage"); //$NON-NLS-1$
        String targetProject = attributes.getProperty("targetProject"); //$NON-NLS-1$
        String implementationPackage = attributes
                .getProperty("implementationPackage"); //$NON-NLS-1$

        javaClientGeneratorConfiguration.setConfigurationType(type);
        javaClientGeneratorConfiguration.setTargetPackage(targetPackage);
        javaClientGeneratorConfiguration.setTargetProject(targetProject);
        javaClientGeneratorConfiguration
                .setImplementationPackage(implementationPackage);

        NodeList nodeList = node.getChildNodes();
        for (int i = 0; i < nodeList.getLength(); i++) {
            Node childNode = nodeList.item(i);

            if (childNode.getNodeType() != Node.ELEMENT_NODE) {
                continue;
            }

            if ("property".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseProperty(javaClientGeneratorConfiguration, childNode);
            }
        }
    }


2.通過上面的方法我們看到有一個JavaClientGeneratorConfiguration物件接受xml資料,所以我們也copy一份JavaClientGeneratorConfiguration改造成適合自己業務的物件
package org.mybatis.generator.config;

import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;
import static org.mybatis.generator.internal.util.messages.Messages.getString;

import java.util.List;

import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.XmlElement;

/**
 * @author shadow
 */
public class JavaParamConfiguration extends TypedPropertyHolder {
	
    private String baseDAO; // baseDAO類路徑
    private String baseService; //baseService類路徑
    private String buildType; // 1.dao層 2.service層 3.control層

    public JavaParamConfiguration() {
        super();
    }

    public String getBaseDAO() {
		return baseDAO;
	}

	public void setBaseDAO(String baseDAO) {
		this.baseDAO = baseDAO;
	}

	public String getBaseService() {
		return baseService;
	}

	public void setBaseService(String baseService) {
		this.baseService = baseService;
	}

	public String getBuildType() {
		return buildType;
	}

	public void setBuildType(String buildType) {
		this.buildType = buildType;
	}

	public XmlElement toXmlElement() {
        XmlElement answer = new XmlElement("javaParam"); //$NON-NLS-1$
        
        if (baseDAO != null) {
            answer.addAttribute(new Attribute("baseDAO", baseDAO)); //$NON-NLS-1$
        }

        if (baseService != null) {
            answer.addAttribute(new Attribute("baseService", baseService)); //$NON-NLS-1$
        }
        
        if (buildType != null) {
            answer.addAttribute(new Attribute("buildType", buildType)); //$NON-NLS-1$
        }

        addPropertyXmlElements(answer);

        return answer;
    }

    public void validate(List<String> errors, String contextId) {

        if (!stringHasValue(baseDAO)) {
            errors.add(getString("ValidationError.12", //$NON-NLS-1$
                    "JavaParamConfiguration", contextId)); //$NON-NLS-1$
        }
        
        if (!stringHasValue(baseService)) {
            errors.add(getString("ValidationError.13", //$NON-NLS-1$
                    "JavaParamConfiguration", contextId)); //$NON-NLS-1$
        }
        
        if (!stringHasValue(buildType)) {
            errors.add(getString("ValidationError.14", //$NON-NLS-1$
                    "JavaParamConfiguration", contextId)); //$NON-NLS-1$
        }

    }
}


3.配置物件已經寫好了,那就在Context物件最頂部加入我們剛剛新建的配置物件

package org.mybatis.generator.config;

import static org.mybatis.generator.internal.util.StringUtility.composeFullyQualifiedTableName;
import static org.mybatis.generator.internal.util.StringUtility.isTrue;
import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;


/**
 * The Class Context.
 *
 * @author Jeff Butler
 */
public class Context extends PropertyHolder {
    
	/** 自定義配置引數 */
    private JavaParamConfiguration javaParamConfiguration;
    
    public JavaParamConfiguration getJavaParamConfiguration() {
		return javaParamConfiguration;
	}

	public void setJavaParamConfiguration(JavaParamConfiguration javaParamConfiguration) {
		this.javaParamConfiguration = javaParamConfiguration;
	}


4.下一步就在MyBatisGeneratorConfigurationParser.java加入下面一段方法,增加一行else if分支呼叫該方法

private void parseJavaParam(Context context, Node node) { // 自定義填充xml引數方法
        JavaParamConfiguration javaParamConfiguration = new JavaParamConfiguration();

        context.setJavaParamConfiguration(javaParamConfiguration);

        Properties attributes = parseAttributes(node);
        String baseDAO = attributes.getProperty("baseDAO"); //$NON-NLS-1$
        String baseService = attributes.getProperty("baseService"); //$NON-NLS-1$
        String buildType = attributes.getProperty("buildType"); //$NON-NLS-1$

        javaParamConfiguration.setBaseDAO(baseDAO);
        javaParamConfiguration.setBaseService(baseService);
        javaParamConfiguration.setBuildType(buildType);

        NodeList nodeList = node.getChildNodes();
        for (int i = 0; i < nodeList.getLength(); i++) {
            Node childNode = nodeList.item(i);

            if (childNode.getNodeType() != Node.ELEMENT_NODE) {
                continue;
            }

            if ("property".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseProperty(javaParamConfiguration, childNode);
            }
        }
    }

private void parseContext(Configuration configuration, Node node) {

        Properties attributes = parseAttributes(node);
        String defaultModelType = attributes.getProperty("defaultModelType"); //$NON-NLS-1$
        String targetRuntime = attributes.getProperty("targetRuntime"); //$NON-NLS-1$
        String introspectedColumnImpl = attributes
                .getProperty("introspectedColumnImpl"); //$NON-NLS-1$
        String id = attributes.getProperty("id"); //$NON-NLS-1$

        ModelType mt = defaultModelType == null ? null : ModelType
                .getModelType(defaultModelType);

        Context context = new Context(mt);
        context.setId(id);
        if (stringHasValue(introspectedColumnImpl)) {
            context.setIntrospectedColumnImpl(introspectedColumnImpl);
        }
        if (stringHasValue(targetRuntime)) {
            context.setTargetRuntime(targetRuntime);
        }

        configuration.addContext(context);

        NodeList nodeList = node.getChildNodes();
        for (int i = 0; i < nodeList.getLength(); i++) {
            Node childNode = nodeList.item(i);

            if (childNode.getNodeType() != Node.ELEMENT_NODE) {
                continue;
            }

            if ("property".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseProperty(context, childNode);
            } else if ("plugin".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parsePlugin(context, childNode);
            } else if ("commentGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseCommentGenerator(context, childNode);
            } else if ("jdbcConnection".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJdbcConnection(context, childNode);
            } else if ("connectionFactory".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseConnectionFactory(context, childNode);
            } else if ("javaModelGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaModelGenerator(context, childNode);
            } else if ("javaTypeResolver".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaTypeResolver(context, childNode);
            } else if ("sqlMapGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseSqlMapGenerator(context, childNode);
            } else if ("javaClientGenerator".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseJavaClientGenerator(context, childNode);
            }else if ("javaParam".equals(childNode.getNodeName())) { // 新增自定義引數填充分支
                parseJavaParam(context, childNode);
            } else if ("table".equals(childNode.getNodeName())) { //$NON-NLS-1$
                parseTable(context, childNode);
            }
        }
    }

5.然後在配置檔案增加我們的節點,還需要修改mybatis-generator-config_1_0.dtd識別我們新增加的節點名稱(javaParam?)

注意事項,請把按dtd的節點順序排列配置xml中的節點,否則會報錯

<?xml version="1.0" encoding="UTF-8"?>    
<!DOCTYPE generatorConfiguration    
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"    
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>

    <!-- 資料庫驅動 -->
    <classPathEntry location="lib/mysql-connector-java-5.1.18.jar" />
    
    <context id="MySQLTables" targetRuntime="MyBatis3">
    
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false" />
        </commentGenerator>
        
        <!--資料庫連結URL，使用者名稱、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://127.0.0.1:3306/qfd" userId="admin"
            password="admin">
        </jdbcConnection>
        
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
        
        <!-- 生成模型的包名和位置 -->
        <javaModelGenerator targetPackage="com.test.domain"
            targetProject="project">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        
        <!-- 生成對映檔案的包名和位置 -->
        <sqlMapGenerator targetPackage="com.test.dao.mapper"
            targetProject="project">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
        
        <!-- 生成DAO的包名和位置 -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.test.dao" targetProject="project">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        
        <!--自定義XML引數配置 -->
        <javaParam baseDAO="com.test.BaseDAO" baseService="com.test.BaseService" buildType="1,2" >
        </javaParam>
        
        <!-- 配置生成表 -->
        <table tableName="qfd_sketch" enableCountByExample="false"
            enableDeleteByExample="false" enableSelectByExample="false"
            enableUpdateByExample="false">
            <property name="modelOnly" value="false" />
        </table>
        
    </context>
    
</generatorConfiguration>   

<!--
  The context element is used to describe a context for generating files, and the source
  tables.
-->
<!ELEMENT context (property*, plugin*, commentGenerator?, (connectionFactory | jdbcConnection), javaTypeResolver?,
                         javaModelGenerator, sqlMapGenerator?, javaClientGenerator?, javaParam?, table+)>
<!ATTLIST context id ID #REQUIRED
  defaultModelType CDATA #IMPLIED
  targetRuntime CDATA #IMPLIED
  introspectedColumnImpl CDATA #IMPLIED>

<!-- 自定義XML節點 -->
<!ELEMENT javaParam (property*)>
<!ATTLIST javaParam
  baseDAO CDATA #REQUIRED
  baseService CDATA #REQUIRED
  buildType CDATA #REQUIRED>

最後總結,這次程式碼需要有點程式碼基礎才可以比較好理解,所以如果還不懂的童靴可以再試多兩次,再次感謝大家的支援

相關推薦

mybatis-generator擴充套件教程系列 -- 自定義generatorConfig.xml引數

        今天我打算講如何在生成器的xml配置檔案里加入自定義的引數,真實很多場景我們會遇到需要自定義BaseDAO,BaseService類路徑,所以這個時候為了擴充套件我們會考慮把這些引數放到xml配置,下面就延續使用上一篇的教程專案來做程式碼示例(如果沒有看過之前

mybatis-generator擴充套件教程系列 -- 自定義sql xml檔案

         今天抽空寫一下生成器比較重要的環節,如何自定義mybatis生成器的sql xml檔案,因為原生出來的格式不好看,命名也不符合我們日常使用習慣,很多冗餘的sql節點,下面我直接直入主題演示程式碼了,還是老規矩使用之前教程延續下來的專案用例1.先看看我們原始生

mybatis-generator擴充套件教程系列 -- 自定義配置引數修改DAO,Mapper檔案字尾

         今天主要講解如何解決我們使用mybatis生成器遇到的最常見問題,如何修改生成的dao,mapper檔案字尾,下面我們繼續使用上一篇的用例繼續改造,如果本篇示例看得不太理解的可以翻看下之前的演示,下面就開始直奔主題了1. 先增加一個引數配置看我們的檔案生成字

mybatis-generator擴充套件教程系列 -- mapper xml檔案增加自定義sql

     今天我教大家如何在mapper.xml檔案裡增加我們自定義的sql節點,還是老規矩沿用之前的專案用例,如有看不懂的同學可以翻看下上幾篇的教程1.開啟IntrospectedTable.java找到enum InternalAttribute這個列舉定義增加一行我們的

mybatis-generator擴充套件教程系列 -- 搭建MBG原始碼專案(入門鋪墊篇)

      沉寂好久又開始發表文章(工作原因),這次我打算教大夥如何深入改造擴充套件mybatis的生成器框架,因為我們現在很多公司都是使用mybatis作為一個數據庫查詢元件,所以一個符合公司專案規範mybatis生成器是一個開發神器;至於有的牛人公司就是自己開發團隊造個輪

Mybatis-generator修改原始碼實現自定義方法,返回List物件（三）

前兩篇文章我們講了如何獲取原始碼即建立工程、修改原始碼為dao（mapper）層新增一個方法，那麼這一篇，我們來講如何在xml新增這個方法所需要sql 3、實現XML檔案新增Dao(Mapper)層的實現 前面有講過，下圖中的兩個包，分別是管理dao(M

Mybatis-generator修改原始碼實現自定義方法,返回List物件（二）

上一篇我們講了如何獲取Mybatis-generator的原始碼和建立工程，以及通過main方法來生成XML、實體類、mapper檔案，這一篇我們來講通過修改程式碼來為mapper新增一個方法 2、組合原始碼中的示例，實現Dao(Mapper)層新增一個

Mybatis-generator修改原始碼實現自定義方法,返回List物件（一）

Mybatis-generator修改原始碼實現自定義方法,返回Lsit物件——第一篇 本文結合網上的諸多教程，詳細介紹通過修改Mybatis-generator的原始碼， 在自動生成dao層和XML檔案時，新增一個返回List的方法,資料庫使用Mysql

【MyBatis Generator】程式碼自動生成工具 generatorConfig.xml配置檔案詳解

MyBatis Generator官網地址：http://www.mybatis.org/generator/index.html MyBaris Generator中文地址：http://mbg.cndocs.ml/ 在MBG中，最主要也最重要的，就是generatorConfig.xml

搜尋引擎solr系列---自定義擴充套件詞庫的配置

  如果配置好分詞，它會智慧分詞，對於一些特殊的詞句，可能不會分成你想要的詞   比如這麼一句話，“清池街辦新莊村”，配置好分詞後，會有如下的結果：   分詞後的結果，並沒有你想要的“清池街辦新莊村”的這個詞，這種情況就需要配置自定義的擴充套件詞庫了。

mybatis generator 自定義 ，xml 檔名稱和內容自定義，dao名稱自定義

最近在用mybatis generator 生成程式碼的時候，生成的xml檔案 和類檔案 不是自己想要的，於是修改mybatis generator 的原始碼，重寫方法來達到效果，這裡記錄一下，後期如果需要還可以隨便改成自己想要的！ 一 修改註釋     &nb

【稀飯】react native 實戰系列教程之自定義原生UI元件

上一節，講了關於RN的自定義原生模組，本節是關於自定義原生UI元件，學習完本節，你將瞭解到原生UI元件的開發流程，以及js如何向native傳送命令和native如何向js傳送事件。 原生UI元件之VideoView視訊播放器開發 React Nativ

Spring Boot2 系列教程(六)自定義 Spring Boot 中的 starter

我們使用 Spring Boot，基本上都是沉醉在它 Stater 的方便之中。Starter 為我們帶來了眾多的自動化配置，有了這些自動化配置，我們可以不費吹灰之力就能搭建一個生產級開發環境，有的小夥伴會覺得這個 Starter 好神奇呀！其實 Starter 也都是 Spring + SpringMVC

xpadder教程：自定義設置手柄的圖片

電腦 add 打開 tps 壓縮 背景圖 file 點擊 必須 關於xpadder設置按鍵的教程，網上已經很多，我就不湊這個熱鬧了。這裏介紹的是如何自定義設置手柄的圖片，就是按鈕的背景圖，如下圖所示： 步驟： 1）準備一張背景圖 註意：格式必須是24位色的BMP位圖，

golang教程之自定義錯誤

文章目錄 自定義錯誤 使用New函式建立自定義錯誤 使用Errorf向錯誤新增更多資訊 使用結構型別和欄位提供有關錯誤的更多資訊 使用結構型別的方法提供有關錯誤的更多資訊 自定義錯誤 原文

mybatis-generator擴充套件

在新公司的新專案想用mybatis-generator來生成DAO層，有同事提出一些改進意見，遂獲得原始碼後進行小幅改造。 目標： 中文註釋，精簡註釋 Model類使用lombok簡化 增加selectOneByExample方法（較多的使用唯一索引查詢場景） 首先獲得原始碼 在任一

SSM Mybatis二級快取深入學習——自定義sql語句開啟關閉快取

原文連結： https://inx.fun/p/526.html SSM Mybatis二級快取深入學習——自定義sql語句開啟關閉快取 木來 我在我自己的SSM專案中部署了二級快取，一開始沒有察覺，但是當我不停的去進行更新與修改操作的時候，我發現二級快取沒有用，這就很難受。 於

Spring擴充套件自定義的XML標籤

在網上搜了許多，感覺不夠全面，就找了官方文件，下面記錄如何找到對應的文件進入  網上許多部落格都是以dateformat為例項進行編寫的，通過官方的foo，能夠學到更多的東西，下面貼一段程式碼，在官方示例上改了一點解析程式碼： package com.theory.spri

django教程7--自定義後臺表單

這篇教程承接 教程第 6 部分 結束的地方。我們繼續修改線上投票應用，這次我們專注於自定義我們在 教程第 2 部分 初見過的 Django 自動生成後臺的過程。 自定義後臺表單¶ 通過 admin.site.register(Question) 註冊 Question

Jmeter教程(二)--自定義變數模擬多使用者

在上一篇文章 Jmeter教程(一)–入門 中介紹了Jmeter的基本用法。本文會繼續介紹如何使用Jmeter對一個帶引數的http請求進行壓測，以及如何設定多個變數模擬多使用者傳送請求。 一、如何建立