MyBatis的一個主要的特色就是須要程序員本身編寫sql,那麼若是表太多的話,不免會很麻煩,因此mybatis官方提供了一個逆向工程,能夠針對單表自動生成mybatis執行所須要的代碼(包括mapper.xml、mapper.java、po..)。通常在開發中,經常使用的逆向工程方式是經過數據庫的表生成代碼。java
使用MyBatis的逆向工程,須要導入逆向工程的jar包,我用的是mybatis-generator-core-1.3.2.jar
,下面開始總結一下MyBatis逆向工程的使用步驟。mysql
咱們要新建一個java工程,這個工程專門用來使用逆向工程生成代碼的。有些人可能會問,爲何要新建一個工程呢?直接在原來工程中你想生成不就能夠了麼?確實是這樣,能夠在原來的工程中生成,可是有風險,由於MyBatis是根據配置文件來生成的(下面會說到),若是生成的路徑中有相同的文件,那麼就會覆蓋原來的文件,這樣會有風險。因此開發中通常都會新建一個java工程來生成,而後將生成的文件拷貝到本身的工程中,這也不麻煩,並且很安全。以下:
程序員
從上圖中看,①就是要執行的java代碼,執行它便可生成咱們須要的代碼;②是執行過程當中新建的包,這個包均可以在④的配置文件中指定,最好是跟咱們本身項目的包名一致,後面就能夠直接拷貝了,就不須要修改包名了;③就是jar包咯;④是配置文件,下面會詳細分析。
如若須要MyBatis的逆向工程——generatorSqlmapCustom,可點擊MyBatis的逆向工程——generatorSqlmapCustom進行下載!spring
MyBatis逆向工程生成代碼須要一個配置文件,名字隨便起。而後MyBatis會根據這個配置文件中的配置,生成相應的代碼。mybatis-generator-core-1.3.2.jar
這個jar包裏面有幫助文檔,打開后里面有配置文件的模板,這裏就再也不贅述了,下面先把配置文件寫好sql
<?xml version="1.0" encoding="UTF-8"?>數據庫
<!DOCTYPE generatorConfigurationapache
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"安全
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">mybatis
<generatorConfiguration>oracle
<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>
從上面的配置文件中能夠看出,配置文件主要作的幾件事是:
配置文件搞好了,而後就執行如下程序便可生成代碼了,生成的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整合Spring的工程案例中,以下:
接着在Spring核心配置文件——application-context.xml添加以下配置:
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<!-- 配置要掃描的包,若是掃描多個包使用半角逗號分隔 -->
<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/applicationContext.xml");
}
@Test
public void testDeleteByPrimaryKey() {
fail("Not yet implemented");
}
@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 = 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() {
fail("Not yet implemented");
}
}
能夠看出,逆向工程生成的代碼,基本上和以前使用的差很少,只不過它更規範一點,並且還多了自定義查詢條件的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>
//注意:這裏的配置必定要是本地mysqlj的ar文件路徑. 這是指向的是個人maven倉庫的地址
<classPathEntry location="C:\ToolsAndDevelope\develop\repository_ssh\mysql\mysql-connector-java\5.1.6\mysql-connector-java-5.1.6.jar"/>
<context id="context" targetRuntime="MyBatis3">
<commentGenerator>
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="true"/>
</commentGenerator>
<jdbcConnection userId="root" password="root" driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis_db"/>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<javaModelGenerator targetPackage="com.lifeibai.domian" targetProject=".">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
<property name="" value=""
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.lifeibai.mapper" targetProject=".">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator targetPackage="com.lifeibai.mapper" type="XMLMAPPER" targetProject=".">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<table schema="" tableName="user" enableCountByExample="false" enableDeleteByExample="false"
enableSelectByExample="false" enableUpdateByExample="false"/>
<table schema="" tableName="orders" enableCountByExample="false" enableDeleteByExample="false"
enableSelectByExample="false" enableUpdateByExample="false"/>
</context>
</generatorConfiguration>
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.lifeibia.mybaitis_demo_002</groupId>
<artifactId>mybaitis_demo_002</artifactId>
<version>1.0-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>
</project>
注意:maven項目運行插件, generatorConfig文件的子元素屬性:targetProject的路徑必須是./src/main/java
<javaModelGenerator targetPackage="com.lifeibai.domian" targetProject="./src/main/java ">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
<property name="" value=""
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.lifeibai.mapper" targetProject="./src/main/java.>
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator targetPackage="com.lifeibai.mapper" type="XMLMAPPER" targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
注意: javaModelGenerator, sqlMapGenerator, javaClientGenerator的targetPackage指向的包,必定要<先建立出來>如:com.lifebai.mapper. 這個是與maven plugin插件不一樣的地方,maven plugin插件會針對沒有的目錄進行建立,MyBatis的插件並不會
<javaModelGenerator targetPackage="com.lifeibai.domian" targetProject="./src/main/java ">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
<property name="" value=""
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.lifeibai.mapper" targetProject="./src/main/java.>
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator targetPackage="com.lifeibai.mapper" type="XMLMAPPER" targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
1,下載MyBatis plugin插件
2,在resources下郵件新建文件
3,編寫好GeneratorConfig.xml文件後,選中該文件,或在文件中右鍵:
最後generatordiamante奉上,下面注意,必定要有本地數據庫鏈接的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>
<classPathEntry location="C:\ToolsAndDevelope\develop\repository_ssh\mysql\mysql-connector-java\5.1.6\mysql-connector-java-5.1.6.jar"/>
<context id="context" targetRuntime="MyBatis3">
<commentGenerator>
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="true"/>
</commentGenerator>
<jdbcConnection userId="root" password="root" driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis_db"/>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<javaModelGenerator targetPackage="com.lifeibai.domian" targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.lifeibai.mapper" targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator targetPackage="com.lifeibai.mapper" type="XMLMAPPER" targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<table schema="" tableName="user" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/> <table schema="" tableName="orders" enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false" enableUpdateByExample="false"/> </context></generatorConfiguration>