注解開發
最初設計時，MyBatis 是一個 XML 驅動的框架。配置信息是基於 XML 的，而且映射語句也是定義在 XML 中的。隨着技術的更新發展,對於開發效率要求也原來越高,特別是一些小型項目;越來越多的框架開始支持注解,
到MyBatis3時,MyBatis對注解有了完善的支持,利用注解可以在一些情況下提高開發效率
但不幸的是，Java 注解的的表達力和靈活性十分有限。盡管很多時間都花在調查、設計和試驗上， 最強大的 MyBatis 映射並不能用注解來構建
1. select
接口方法聲明:
import com.yyh.pojo.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper2 {
@Select("select * from kuser where id = #{id}")
public User selectUserByID(int id);
}
測試方法:
@Test
public void selectTest(){
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
User user = mapper.selectUserByID(2);
System.out.println(user);
session.close();
}
不要忘記注冊這個接口到全局配置中
<mappers>
<mapper class="com.yyh.mapper.UserMapper2"/>
</mappers>
2. sql語句多個參數
接口方法聲明:
@Select("select * from kuser where sex = #{sex} and name like '%${name}%'")
public List<User> selectUserBySexAndName(@Param("sex") String sex, @Param("name") String name);
測試方法:
@Test
public void selectTest2(){
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
List<User> users = mapper.selectUserBySexAndName("1","張");
System.out.println(users);
session.close();
}
當sql語句需要多個參數時則必須將多個參數打包到一個對象中,通常是POJO或Map,上面的案例中使用了@Param注解本質就是告訴MyBatis有多個參數MyBatis會自動創建一個Map,然后將@Param的值作為Key,然后將Map傳給sql,你也可以手動傳一個Map
接口方法聲明:
@Select("select * from kuser where sex = #{sex} and name like '%${name}%'")
public List<User> selectUserBySexAndName(Map<String,Object> params);
測試方法:
@Test
public void selectTest2(){
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
Map<String,Object> params = new HashMap<>(); //存儲參數的Map
params.put("sex","1");
params.put("name","張");
List<User> users = mapper.selectUserBySexAndName(params);
System.out.println(users);
session.close();
}
3. insert
接口方法聲明:
@Insert("insert into kuser values(null,#{name},#{birthday},#{sex},#{address})")
public int insertUser(User user);
測試方法:
@Test
public void insertTest() {
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
User user = new User();
user.setName("jerry");
user.setSex("1");
user.setAddress("亞洲中國");
user.setBirthday(new Date());
mapper.insertUser(user);
session.commit();
session.close();
}
獲取自增主鍵
在@select注解的下方添加@selectKey注解來完成對自增主鍵的獲取
@Insert("insert into kuser values(null,#{name},#{birthday},#{sex},#{address})")
@SelectKey(statement = "select last_insert_id()",keyProperty = "id",resultType = Integer.class,before = false)
public int insertUser(User user);
在執行insert之后執行last_insert_id()函數獲取自增值,然后放入對象的某個屬性中;
4. update
接口方法聲明:
@Update("update kuser set name = #{name}, birthday = #{birthday}, sex = #{sex}, address = #{address} where id = #{id}")
public int updateUser(User u);
// 如果一行太長可以換行些 但是要注意sql語法
測試方法:
@Test
public void updateTest() {
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
User user = mapper.selectUserByID(1);
user.setName("王六子");
mapper.updateUser(user);
session.commit();
session.close();
}
5.delete
接口方法聲明:
@Delete("delete from kuser where id = #{id}")
public int deleteUserByID(int id);
測試方法:
@Test
public void deleteTest() {
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
mapper.deleteUserByID(12);
session.commit();
session.close();
}
6. 動態sql
動態sql指語句中包含邏輯代碼,需要先運行邏輯代碼,最后產生sql語句,所以需要在注解中告訴MyBatis這是一個動態sql,通過<script>sql....</script>語法來指定;
若想要在sql中使用各種標簽則必須添加上述根標簽,否則MyBatis會將整體作為sql語句
接口方法聲明:
@Select("<script>" +
"select * from kuser" +
"<where>" +
"<if test='name != null'>" +
"and name like '%${name}%'" +
"</if>" +
"<if test='sex != null'>" +
"and sex = #{sex}" +
"</if>" +
"</where>" +
"</script>")
public List<User> searchUserByNameAndSex(@Param("name") String name,@Param("sex") String sex);
測試代碼:
@Test
public void dynamicSqlTest(){
SqlSession session = factory.openSession();
UserMapper2 mapper = session.getMapper(UserMapper2.class);
List<User> users = mapper.searchUserByNameAndSex(null,null);
// List<User> users = mapper.searchUserByNameAndSex("張",null);
// List<User> users = mapper.searchUserByNameAndSex("張", "2");
System.out.println(users);
session.close();
}
7.結果映射(ResultMap)
1.自定義字段與屬性對應關系
准備工作:將數據庫中的name字段修改為username,然后我們通過ResultMap來手動映射name字段
接口方法聲明:
@Select("select *from kuser where username = #{name}")
@Results({
@Result(id = true,column = "id",property = "id"),
@Result(column = "username",property = "name"),
})
public User selectUserByName(String name);
測試代碼省略..
重復使用Results
可以發現,MyBatis默認會自動映射所有字段和屬性匹配的數據,另外id表示是否為主鍵字段,默認為false
強調:Results可以位於對應方法的上面或下面,但是無法跨域其他方法,默認只對當前方法有效,如果需要重復使用則需要為其指定id
接口方法聲明:
//定義
@Results(id="map1",value = {
@Result(id = true,column = "id",property = "id"),
@Result(column = "username",property = "name"),
})
//.....中間必須間隔其他方法不能立即應用到某個ResultMap
使用:
@Select("select *from kuser where username = #{name}")
//通過@ResultMap注解 並傳入id來使用
@ResultMap("map1")
public User selectUserByName(String name);
注意:
@Results的定義不能和使用它的@ResultMap一起出現,既然是重復使用的,建議統一放在接口的最上面,
如果是當前要使用的並且要重用,直接使用Results即可,不需要在下面添加ResultMap就像下面這樣:
@Select("select *from kuser where username = #{name}")
@Results(id="map1",value = {
@Result(id = true,column = "id",property = "id"),
@Result(column = "username",property = "name"),
})
public User selectUserByName(String name);
2.關聯查詢
一對多關聯
//實現根據用戶姓名查詢用戶信息和訂單信息
@Select("select *from kuser where username = #{name}")
@Results(value = {
@Result(id = true,column = "id",property = "id"),
@Result(column = "username",property = "name"),
//一對多關聯,指定子查詢語句的方法名稱(全限定名稱)column指定傳給子查詢的參數
@Result(column = "id",property = "orders",many = @Many(select = "com.yyh.mapper.UserMapper2.selectOrdersByID")),
})
public User selectUserAdnOrdersByUserName(String name);
//注意這里的條件字段時order表中的字段
@Select("select *from Orders where user_id = #{id}")
public List<Order> selectOrdersByID(int id);
一對一關聯 只需要修改屬性名稱和注解名稱即可:
@Select("select *from orders where id = #{id}")
@Results(value = {
@Result(id = true,column = "id",property = "id"),
@Result(column = "user_id",property = "user" ,one = @One(select = "com.yyh.mapper.UserMapper2.selectUserByID")),
})
public Order selectOrderByID(int id);
逆向工程(generator)
generator翻譯為生成器,是MyBatis開源的一個插件,可以從數據庫獲取表信息,自動生成Mapper.xml,POJO,以及Mapper接口
但問題是,MyBatis不可能完全清楚我們的業務需求,所以其自動生成的sql只能滿足基本的CRUD操作,而無法幫助我們進行連表操作,(當然包括帶有條件的CRUD)
使用步驟
1.使用Maven添加generator插件
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<!-- 是否覆蓋已存在的接口和POJO該配置不包括Mapper
若為False將會生成版本記錄-->
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>
2.創建數據庫配置文件,位於resource下名為jdbc.properties
driver = com.mysql.jdbc.Driver
url = jdbc:mysql:///HMDB?serverTimezone=Asia/Shanghai&characterEncoding=utf8&useSSL=false
user = root
password = admin
location = /Users/jerry/.m2/repository/mysql/mysql-connector-java/5.1.44/mysql-connector-java-5.1.44.jar
3.創建配置文件,位於resource下名為generatorConfig.xml
<?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 resource="jdbc.properties"></properties>
<!--指定特定數據庫的jdbc驅動jar包的位置-->
<classPathEntry location="${location}"/>
<context id="default" targetRuntime="MyBatis3">
<!-- optional，旨在創建class時，對注釋進行控制 -->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--jdbc的數據庫連接 -->
<jdbcConnection
driverClass="${driver}" connectionURL="${url}" userId="${user}" password="${password}">
</jdbcConnection>
<!-- 非必需，類型處理器，在數據庫類型和java類型之間的轉換控制-->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!--Model模型生成器,用來生成含有主鍵key的類，記錄類 以及查詢Example類
targetPackage 指定生成的model生成所在的包名
targetProject 指定在該項目下所在的路徑 -->
<javaModelGenerator targetPackage="com.yyh.pojo" targetProject="src/main/java">
<!-- 是否允許子包，即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="false"/>
<!-- 是否對model添加 構造函數 -->
<property name="constructorBased" value="true"/>
<!-- 是否對類CHAR類型的列的數據進行trim操作 -->
<property name="trimStrings" value="true"/>
<!-- 建立的Model對象是否 不可改變 即生成的Model對象不會有 setter方法，只有構造方法 -->
<property name="immutable" value="false"/>
</javaModelGenerator>
<!--mapper映射文件生成所在的目錄 為每一個數據庫的表生成對應的SqlMap文件 -->
<sqlMapGenerator targetPackage="com.yyh.dao"
targetProject="src/main/resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!--mapper接口文件生成所在的目錄 為每一個數據庫的表生成對應的接口文件 -->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.yyh.dao" targetProject="src/main/java">
<!-- enableSubPackages:是否讓schema(數據庫名稱)作為包的后綴 -->
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!--指定需要生成的表-->
<table tableName="category"></table>
<table tableName="orders"></table>
<table tableName="products"></table>
<table tableName="kuser"></table>
</context>
</generatorConfiguration>
若自定義配置文件名稱則需要在pom中指定
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<!-- 自定義配置文件 相對於項目根目錄-->
<configurationFile>src/main/resources/aaaa.xml</configurationFile>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>
3.運行generator
可在idea右側的maven菜單中雙擊執行mybatis-generator:generate
也可利用maven命令執行:mybatis-generator:generate
4.條件查詢的使用查看POJO包,會發現每個POJO對應了一個Example,這是什么呢?
generator的目標是盡可能的幫我們減少sql的編寫,如果只能進行簡單的CRUD那意義不大,於是generator使用了一套Example來幫助我們用OOP(面向對象)的方式來完成SQL中的條件拼接
其設計思想是將條件看做是一個對象,該對象包含了SQL中常見的比較,邏輯運算等......打開文件你會發現其本質就是幫我們拼接響應的sql符號和關鍵字
5.CRUD案例
import com.yyh.dao.KuserMapper;
import com.yyh.pojo.Kuser;
import com.yyh.pojo.KuserExample;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class GeneratorTest {
private SqlSessionFactory factory;
@Before
public void init() throws IOException {
//獲取的工廠構造器
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
//加載配置文件
InputStream stream = Resources.getResourceAsStream("mybatis-config.xml");
//獲得會話工廠
factory = builder.build(stream);
}
//查詢
@Test
public void test(){
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
Kuser kuser = mapper.selectByPrimaryKey(1);
System.out.println(kuser.getSex());
System.out.println(kuser.getAddress());
System.out.println(kuser.getBirthday());
System.out.println(kuser.getUsername());
}
//修改
@Test
public void test2(){
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
Kuser kuser = mapper.selectByPrimaryKey(1);
kuser.setUsername("XXXXXXXXX");
mapper.updateByPrimaryKey(kuser);
session.commit();
}
//添加
@Test
public void test3(){
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
Kuser auser = new Kuser();
auser.setUsername("jack");
auser.setAddress("北京東城");
mapper.insert(auser);
session.commit();
}
//刪除
@Test
public void test4() {
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
mapper.deleteByPrimaryKey(13);
session.commit();
}
//and條件
@Test
public void test5() {
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
KuserExample kuserExample = new KuserExample();
KuserExample.Criteria criteria = kuserExample.createCriteria();
criteria.andBirthdayIsNotNull();
criteria.andUsernameLike("%張%");
List<Kuser> kusers = mapper.selectByExample(kuserExample);
System.out.println(kusers);
}
// or條件
@Test
public void test6() {
SqlSession session = factory.openSession();
KuserMapper mapper = session.getMapper(KuserMapper.class);
KuserExample kuserExample = new KuserExample();
//創建一個條件對象,可以包含n個and
KuserExample.Criteria criteria1 = kuserExample.createCriteria();
criteria1.andUsernameLike("%張%");
//創建一個條件對象可以包含n個and,且前面添加or關鍵字
KuserExample.Criteria criteria2 = kuserExample.or();
criteria2.andBirthdayIsNull();
//最終的意思是 名字帶有張的 或者生日為空的; 具體查看生產的sql即可
List<Kuser> kusers = mapper.selectByExample(kuserExample);
System.out.println(kusers);
}
}
注意:重新生成的Mapper文件時不會不會覆蓋之前的Mapper,而是會直接在里面添加sql導致id沖突,所以重新生成mapper時一定要手動刪除已存在的mapper