Mybatis逆向工程簡單介紹

轉自：https://blog.csdn.net/yerenyuan_pku/article/details/71909325

什么是逆向工程

MyBatis的一個主要的特點就是需要程序員自己編寫sql，那么如果表太多的話，難免會很麻煩，所以mybatis官方提供了一個逆向工程，可以針對單表自動生成mybatis執行所需要的代碼（包括mapper.xml、mapper.java、po..）。一般在開發中，常用的逆向工程方式是通過數據庫的表生成代碼。

使用逆向工程

使用MyBatis的逆向工程，需要導入逆向工程的jar包，我用的是mybatis-generator-core-1.3.2.jar，下面開始總結一下MyBatis逆向工程的使用步驟。

新建一個工程（重要）

我們要新建一個java工程，這個工程專門用來使用逆向工程生成代碼的。有些人可能會問，為什么要新建一個工程呢？直接在原來工程中你想生成不就可以了么？確實是這樣，可以在原來的工程中生成，但是有風險，因為MyBatis是根據配置文件來生成的（下面會說到），如果生成的路徑中有相同的文件，那么就會覆蓋原來的文件，這樣會有風險。所以開發中一般都會新建一個java工程來生成，然后將生成的文件拷貝到自己的工程中，這也不麻煩，而且很安全。如下：

從上圖中看，①就是要執行的java代碼，執行它即可生成我們需要的代碼；②是執行過程中新建的包，這個包都可以在④的配置文件中指定，最好是跟我們自己項目的包名一致，后面就可以直接拷貝了，就不需要修改包名了；③就是jar包咯；④是配置文件，下面會詳細分析。
讀者如若需要MyBatis的逆向工程——generatorSqlmapCustom，可點擊MyBatis的逆向工程——generatorSqlmapCustom進行下載！

配置逆向工程的配置文件

MyBatis逆向工程生成代碼需要一個配置文件，名字隨便起。然后MyBatis會根據這個配置文件中的配置，生成相應的代碼。mybatis-generator-core-1.3.2.jar這個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="yezi">
        </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="com.itheima.mybatis.po" targetProject=".\src">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
            <!-- 從數據庫返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.itheima.mybatis.mapper" targetProject=".\src">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.itheima.mybatis.mapper" targetProject=".\src">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- 指定數據庫表 -->
        <table schema="" tableName="user"></table>
        <table schema="" tableName="orders"></table>

        <!-- 有些表的字段需要指定java類型 <table schema="" tableName=""> <columnOverride column="" javaType="" /> </table> -->
    </context>
</generatorConfiguration>
   
   
   
           

從上面的配置文件中可以看出，配置文件主要做的幾件事是：

1. 連接數據庫，這是必須的，要不然怎么根據數據庫的表生成代碼呢？
2. 指定要生成代碼的位置，要生成的代碼包括po類，mapper.xml和mapper.java
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();
        }

    }

}
   
   
   
           

運行一下即可，運行完了后刷新一下工程，就可以看到最新生成的代碼了。

這里可以看出有個細節，每個po類多了一個東西，就是xxxExample.java，這個類是給用戶自定義sql使用的，后面我會提到。到這里就生成好了，下面我們就把生成的代碼拷貝到自己的工程使用了。

逆向工程測試

在這里我把生成的代碼拷貝到上文MyBatis框架的學習(六)——MyBatis整合Spring的工程案例中，如下：

接着在Spring核心配置文件——application-context.xml添加如下配置：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <!-- 配置要掃描的包，如果掃描多個包使用半角逗號分隔 -->
    <!-- <property name="basePackage" value="cn.itheima.mybatis.mapper,com.itheima.mybatis.mapper" /> -->
    <property name="basePackage" value="com.itheima.mybatis.mapper" />
</bean>
   
   
   
           

最后編寫UserMapper接口的單元測試類——UserMapperTest.java，內容如下：

public class UserMapperTest {

    private ApplicationContext applicationContext;

    @Before
    public void init() {
        // 初始化Spring容器
        applicationContext = new ClassPathXmlApplicationContext("classpath:spring/application-context.xml");
    }

    @Test
    public void testDeleteByPrimaryKey() {
        // 請讀者自行測試...
    }

    @Test
    public void testInsert() {
        UserMapper userMapper = applicationContext.getBean(UserMapper.class);
        User user = new User();
        user.setUsername("武大郎");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("河北清河縣");
        userMapper.insert(user);
    }

    @Test
    public void testSelectByExample() {
        UserMapper userMapper = applicationContext.getBean(UserMapper.class);
        UserExample example = new UserExample();
        // Criteria類是UserExample類里面的內部類，Criteria類是干什么用的呢？它專門用於封裝自定義查詢條件的
        // Criteria criteria = example.createCriteria();
        // criteria.andUsernameLike("%張%");
        // 執行查詢
        List<User> list = userMapper.selectByExample(example);
        for (User user : list) {
            System.out.println(user);
        }
    }

    @Test
    public void testSelectByPrimaryKey() {
        UserMapper userMapper = applicationContext.getBean(UserMapper.class);
        User user = userMapper.selectByPrimaryKey(10);
        System.out.println(user);
    }

    @Test
    public void testUpdateByPrimaryKey() {
        // 請讀者自行測試...
    }

}
   
   
   
           

可以看出，逆向工程生成的代碼，基本上和之前使用的差不多，只不過它更規范一點，而且還多了自定義查詢條件的java類，用起來還是挺方便的。關於MyBatis的逆向工程就總結到這吧。
最后，我還是給出逆向工程測試的工程吧！讀者可點擊MyBatis框架的學習(七)——MyBatis逆向工程自動生成代碼進行下載。

        <link rel="stylesheet" href="https://csdnimg.cn/release/phoenix/template/css/markdown_views-ea0013b516.css">
            </div>