MyBatis的逆向工程生成代码

1. 什么是逆向工程

　　mybatis的一个主要的特点就是需要程序员自己编写sql，那么如果表太多的话，难免会很麻烦，所以mybatis官方提供了一个逆向工程，可以针对单表自动生成mybatis执行所需要的代码（包括mapper.xml、mapper.java、po..）。一般在开发中，常用的逆向工程方式是通过数据库的表生成代码。

2. 使用逆向工程

　　使用mybatis的逆向工程，需要导入逆向工程的jar包，我用的是mybatis-generator-core-1.3.2，已经上传到下载频道了（点我下载），下面开始总结一下mybatis逆向工程的使用步骤。

2.1 新建一个工程（重要）

　　我们要新建一个java工程，这个工程专门用来使用逆向工程生成代码的。有些人可能会问，为什么要新建一个工程呢？直接在原来工程中你想生成不就可以了么？确实是这样，可以在原来的工程中生成，但是有风险，因为mybatis是根据配置文件来生成的（下面会说到），如果生成的路径中有相同的文件，那么就会覆盖原来的文件，这样会有风险。所以开发中一般都会新建一个java工程来生成，然后将生成的文件拷贝到自己的工程中，这也不麻烦，而且很安全。如下： 


 
　　从上图中看，1就是要执行的java代码，执行它即可生成我们需要的代码；2是执行过程中新建的包，这个包都可以在4的配置文件中指定，最好是跟我们自己项目的包名一致，后面就可以直接拷贝了，就不需要修改包名了；3就是jar包咯；4是配置文件。下面会详细分析。

2.1 生成代码的配置文件

　　mybatis逆向工程生成代码需要一个配置文件，名字随便起。然后mybatis会根据这个配置文件中的配置，生成相应的代码。下载好了jar包后，里面有帮助文档，打开后里面有配置文件的模板，这里就不再赘述了，下面先把配置文件写好：

<?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>
<context id="testTables" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
password="root">
</jdbcConnection>
<!-- <jdbcConnection driverClass="oracle.jdbc.OracleDriver"
connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:yycg"
userId="yycg"
password="yycg">
</jdbcConnection> -->

<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL和NUMERIC类型解析为java.math.BigDecimal -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>

<!-- targetProject:生成PO类的位置，重要！！ -->
<javaModelGenerator targetPackage="mybatis.po"
targetProject=".\src">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
<!-- 从数据库返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- targetProject:mapp
4000
er映射文件生成的位置，重要！！ -->
<sqlMapGenerator targetPackage="mybatis.mapper"
targetProject=".\src">
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- targetPackage：mapper接口生成的位置，重要！！ -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="mybatis.mapper"
targetProject=".\src">
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 指定数据库表，要生成哪些表，就写哪些表，要和数据库中对应，不能写错！ -->
<table tableName="items"></table>
<table tableName="orders"></table>
<table tableName="orderdetail"></table>
<table tableName="user"></table>
</context>
</generatorConfiguration>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
　　从上面的配置文件中可以看出，配置文件主要要做的几件事是：连接数据库，这是必须的，要不然怎么根据数据库的表生成代码呢？
指定要生成代码的位置，要生成的代码包括po类， mapper.xml和mapper.java
指定数据库中想要生成哪些表

2.3 执行生成程序

　　配置文件搞好了，然后就执行以下生成程序即可生成了，生成的java程序，下载的逆向工程文档中都有示例，如下：

public class GeneratorSqlmap {

public void generator() throws Exception{

List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
//指向逆向工程配置文件
File configFile = new File("generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
callback, warnings);
myBatisGenerator.generate(null);

}
public static void main(String[] args) throws Exception {
try {
GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
generatorSqlmap.generator();
} catch (Exception e) {
e.printStackTrace();
}

}

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
　　运行一下即可，运行完了后刷新一下工程，就可以看到最新生成的代码了。 


 
　　这里可以看出有个细节，每个po类多了一个东西，就是xxxExample.java，这个类是给用户自定义sql是用的，后面我会提到。到这里就生成好了，下面我们就把生成的代码拷贝到自己的工程使用了，为了简便，这里我就拷贝ItemsMapper.java/ItemsMapper.xml/Items.java/ItemsExample.java这一类的，其他都一样。

3. 测试生成的代码

　　我们针对ItemsMapper.java新建一个测试类，测试其中的几个方法：

public class ItemsMapperTest {

private SqlSessionFactory sqlSessionFactory;

@Before
public void setUp() throws Exception {
// 创建sqlSessionFactory
String resource = "SqlMapConfig.xml"; // mybatis配置文件

// 得到配置文件的流
InputStream inputStream = Resources.getResourceAsStream(resource);

// 创建会话工厂SqlSessionFactory,要传入mybaits的配置文件的流
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

}

//普通的插入，跟我们之前的插入是一样的
@Test
public void testInsert() {
SqlSession sqlSession = sqlSessionFactory.openSession();
ItemsMapper itemsMapper = sqlSession.getMapper(ItemsMapper.class);

Items items = new Items();
items.setName("手机");
items.setPrice(5000f);
items.setCreatetime(new Date());
itemsMapper.insert(items);
sqlSession.commit();
//还有一个insertSelective(items);方法，是插入的项不为空时，才将那个字段拼接到sql中
//可以下自动生成的xml文件就知道了。
}

//自定义查询
@Test
public void testSelectByExample() {
SqlSession sqlSession = sqlSessionFactory.openSession();
ItemsMapper itemsMapper = sqlSession.getMapper(ItemsMapper.class);

//自定义查询，这就用到了ItemsExample类了，里面有个Criteria内部类，专门用来封装自定义查询条件的
ItemsExample itemsExample = new ItemsExample();
ItemsExample.Criteria criteria = itemsExample.createCriteria();
//andNameEqualTo相当于在sql中拼接一个“AND name='背包'”
//还有其他很多方法，都是用来自定义查询条件的，可以自己看一下不同的方法
criteria.andNameEqualTo("背包");
List<Items> itemsList = itemsMapper.selectByExample(itemsExample);
System.out.println(itemsList);
}

//根据主键查询，跟原来一样
@Test
public void testSelectByPrimaryKey() {
ItemsMapper itemsMapper = sqlSessionFactory.openSession().getMapper(ItemsMapper.class);
Items items = item
baab
sMapper.selectByPrimaryKey(1);
System.out.println(items);
}

//根据主键更新item，跟原来一样
@Test
public void testUpdateByPrimaryKey() {
SqlSession sqlSession = sqlSessionFactory.openSession();
ItemsMapper itemsMapper = sqlSession.getMapper(ItemsMapper.class);
Items items = itemsMapper.selectByPrimaryKey(1);
items.setPrice(3540f);
itemsMapper.updateByPrimaryKey(items);
sqlSession.commit();
}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
　　可以看出，逆向工程生成的代码，基本上和之前使用的差不多，只不过它更规范一点，而且还多了自定义查询条件的java类，用起来还是挺方便的。关于mybatis的逆向工程就总结到这吧。 
　　　　相关阅读：http://blog.csdn.net/column/details/smybatis.html 
　　学习笔记源码下载地址：https://github.com/eson15/MyBatis_Study