MyBatis-Generator最佳实践

CREATE TABLE `test`.`teacher` (
	`id` bigint NOT NULL DEFAULT 0 COMMENT '主键id',
	`name` varchar(40) NOT NULL DEFAULT '' COMMENT '名称',
	`age` smallint NOT NULL DEFAULT 0 COMMENT '年龄',
	PRIMARY KEY (`id`)
) COMMENT='教师表';

# 数据库驱动jar 路径
drive.class.path=/Users/arccode/repo/mysql/mysql-connector-java/5.1.30/mysql-connector-java-5.1.30.jar

# 数据库连接参数
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8
jdbc.username=mysql
jdbc.password=mysqlpwd

# 包路径配置
model.package=com.arccode.web.model
dao.package=com.arccode.web.dao
xml.mapper.package=com.arccode.web.dao

target.project=src/main/java

<?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>
    <!-- 配置文件路径 -->
    <properties url="${mybatis.generator.generatorConfig.properties}"/>

    <!--数据库驱动包路径 -->
    <classPathEntry location="${drive.class.path}"/>

    <context id="MySQLTables" targetRuntime="MyBatis3">
        <!--关闭注释 -->
        <commentGenerator>	
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!--数据库连接信息 -->
        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <!--生成的model 包路径 -->
        <javaModelGenerator targetPackage="${model.package}" targetProject="${target.project}">
            <property name="enableSubPackages" value="ture"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--生成xml mapper文件 路径 -->
        <sqlMapGenerator targetPackage="${xml.mapper.package}" targetProject="${target.project}">
            <property name="enableSubPackages" value="ture"/>
        </sqlMapGenerator>

        <!-- 生成的Dao接口 的包路径 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="${dao.package}" targetProject="${target.project}">
            <property name="enableSubPackages" value="ture"/>
        </javaClientGenerator>

        <!--对应数据库表名 -->
        <table tableName="teacher">

        </table>
    </context>
</generatorConfiguration>

<table tableName="teacher" enableCountByExample="false" 
	enableUpdateByExample="false" enableDeleteByExample="false" 
	enableSelectByExample="false" selectByExampleQueryId="false">
</table>

public void addFieldComment(Field field,
            IntrospectedTable introspectedTable,
            IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }

        StringBuilder sb = new StringBuilder();

        field.addJavaDocLine("/**"); //$NON-NLS-1$
//        field.addJavaDocLine(" * This field was generated by MyBatis Generator."); //$NON-NLS-1$

        sb.append(" *  "); //$NON-NLS-1$
        sb.append(introspectedColumn.getRemarks());
        sb.append(",所属表字段为");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString());

//        addJavadocTag(field, false);

        field.addJavaDocLine(" */"); //$NON-NLS-1$
    }

// 克隆 parent
git clone https://github.com/mybatis/parent.git
// 将该项目安装到本地maven库, mybatis-generator依赖于该项目
mvn clean install -Dmaven.test.skip=true
// 克隆 mybatis-generator
git clone https://github.com/mybatis/generator.git
// 将该jar安装到本地, 之后项目中使用, 时间有点长, 可以喝杯咖啡
mvn clean install -Dmaven.test.skip=true

<commentGenerator>
	<property name="suppressDate" value="false"/>
</commentGenerator>

public class Teacher {

    /**
     *  主键id,所属表字段为teacher.id
     */
    private Long id;

    /**
     *  名称,所属表字段为teacher.name
     */
    private String name;

    /**
     *  年龄,所属表字段为teacher.age
     */
    private Short age;

    /**
     *  性别,所属表字段为teacher.sex
     */
    private String sex;

    /**
     * 获取 主键id 字段:teacher.id
     *
     * @return teacher.id, 主键id
     */
    public Long getId() {
        return id;
    }

    /**
     * 设置 主键id 字段:teacher.id
     *
     * @param id teacher.id, 主键id
     */
    public void setId(Long id) {
        this.id = id;
    }

    /**
     * 获取 名称 字段:teacher.name
     *
     * @return teacher.name, 名称
     */
    public String getName() {
        return name;
    }

    /**
     * 设置 名称 字段:teacher.name
     *
     * @param name teacher.name, 名称
     */
    public void setName(String name) {
        this.name = name == null ? null : name.trim();
    }

    /**
     * 获取 年龄 字段:teacher.age
     *
     * @return teacher.age, 年龄
     */
    public Short getAge() {
        return age;
    }

    /**
     * 设置 年龄 字段:teacher.age
     *
     * @param age teacher.age, 年龄
     */
    public void setAge(Short age) {
        this.age = age;
    }

    /**
     * 获取 性别 字段:teacher.sex
     *
     * @return teacher.sex, 性别
     */
    public String getSex() {
        return sex;
    }

    /**
     * 设置 性别 字段:teacher.sex
     *
     * @param sex teacher.sex, 性别
     */
    public void setSex(String sex) {
        this.sex = sex == null ? null : sex.trim();
    }
}