牛刀杀鸡的java数据库生成model小工具

前言

重复且无用的工作是每个码农必须避免的，DRY(don't repeat yourself)原则也是每个码农重要的素质，当你第二次重复某件事还可以忍受，但是你第三次重复某件事就一定想办法去改变它，让它变得简单。
最近做的项目中没有根据根据库表自动生成java model类的工具，自己写三四十个字段容易出错而且重复繁琐。我根据自己以前的小积累推荐给大家一个原来用于mybatis代码自动生成的小工具（mybatis generator）。ps：这款小工具用到这里有点杀鸡用牛刀了，不过用起来很简单是真的，我也只会讲大家用到的，这样就更容易使用了。

最佳实践

引入mybatis-generator.jar

这个jar包是生成工具最主要的jar包，需要引入你的模块下面。下面就以我的appointment模块给大家做个示范。为了照顾大部分接触java或者eclipse不深的童鞋，我的步骤尽可能的详细。

• 模块右键build path —— configure build path

Paste_Image.png

• 点击librares——add external jars选择mybatis-generator.jar位置，完成如图。最后别忘了点apply完成

Paste_Image.png

添加generatorConfig.xml

添加generatorConfig.xml
generatorConfig.xml文件是添加规则，比如驱动包位置、生成表名字等。这里不详细说，具体的看xml里面的注释即可。为了方便我直接加入到test包下面（另外提倡大家写单测，特别是现在前后台分开了，如果你负责后台没有单测传到svn，前台的童鞋一调就出错会不会骂街？所以单测是很有必要的，单测完了之后调出错你就可以理直气壮说是前台的童鞋写错了O(∩_∩)O）

Paste_Image.png

添加完之后要进去修改部分参数，修改的地方看xml中的注释
编写生成的Java类
为了简单，我也直接在test下直接new一个新的java类，默认会生成在default package（写代码的时候不推荐大家这样做，但是这里直接new就可以否则代码找不到config.xml），就在上图的default package。java类的代码资料里有这里不赘述，代码都一样的不用修改。如下

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

public class Test {
    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        String genCfg = "/generatorConfig.xml";
        File configFile = newFile(Test.class.getResource(genCfg).getFile());
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = null;
        config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = null;
        myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }
}

完成

上述步骤完成之后（主要是xml配置），点开test类，右键run as —— java application就可以生成了，控制台没有输出说明没错，不过可能生成之后有延迟，刷新一下就能在你的工作目录里面看见生成的代码了。如果有错可以谷歌或者百度，或者直接问我，有啥问题会帮你解决。

tips
资源的度盘地址
请仔细阅读xml中的内容
运行之后没有显示model啊
就像上面说的，会有延迟，在你的模块右键刷新一下试试。
可能生成多个model
这是mybatis遇到多个非null的情况，会把非null的属性生成到后缀为key.java的类中，可以拷贝过来删掉key.java即可
还需要调整
生成之后还需要继承其他的通用model以及加注解，需要手动完成。