快速學習-Mybatis 註解開發

• 2020 年 4 月 1 日
• 筆記

第3章 Mybatis 註解開發

這幾年來註解開發越來越流行，Mybatis 也可以使用註解開發方式，這樣我們就可以減少編寫 Mapper 映射文件了。本次我們先圍繞一些基本的 CRUD 來學習，再學習複雜映射關係及延遲載入。

3.1 mybatis 的常用註解說明

@Insert:實現新增  @Update:實現更新  @Delete:實現刪除  @Select:實現查詢  @Result:實現結果集封裝  @Results:可以與@Result 一起使用，封裝多個結果集  @ResultMap:實現引用@Results 定義的封裝  @One:實現一對一結果集封裝  @Many:實現一對多結果集封裝  @SelectProvider: 實現動態 SQL 映射  @CacheNamespace:實現註解二級快取的使用

3.2 使用 Mybatis 註解實現基本 CRUD

單表的 CRUD 操作是最基本的操作，前面我們的學習都是基於 Mybaits 的映射文件來實現的。

3.2.1 編寫實體類

public class User implements Serializable {        private Integer id;      private String username;      private String address;      private String sex;      private Date birthday;        public Integer getId() {          return id;      }        public void setId(Integer id) {          this.id = id;      }        public String getUsername() {          return username;      }        public void setUsername(String username) {          this.username = username;      }        public String getAddress() {          return address;      }        public void setAddress(String address) {          this.address = address;      }        public String getSex() {          return sex;      }        public void setSex(String sex) {          this.sex = sex;      }        public Date getBirthday() {          return birthday;      }        public void setBirthday(Date birthday) {          this.birthday = birthday;      }    //    @Override  //    public String toString() {  //        return "User{" +  //                "id=" + id +  //                ", username='" + username + ''' +  //                ", address='" + address + ''' +  //                ", sex='" + sex + ''' +  //                ", birthday=" + birthday +  //                '}';  //    }  }

注意： 此處我們故意和資料庫表的列名不一致。

3.2.2 使用註解方式開發持久層介面

public interface IUserDao {        /**       * 查詢所有用戶       * @return       */      @Select("select * from user")      List<User> findAll();        /**       * 保存用戶       * @param user       */      @Insert("insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday})")      void saveUser(User user);        /**       * 更新用戶       * @param user       */      @Update("update user set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address} where id=#{id}")      void updateUser(User user);        /**       * 刪除用戶       * @param userId       */      @Delete("delete from user where id=#{id} ")      void deleteUser(Integer userId);        /**       * 根據id查詢用戶       * @param userId       * @return       */      @Select("select * from user  where id=#{id} ")      User findById(Integer userId);        /**       * 根據用戶名稱模糊查詢       * @param username       * @return       */  //    @Select("select * from user where username like #{username} ")      @Select("select * from user where username like '%${value}%' ")      List<User> findUserByName(String username);        /**       * 查詢總用戶數量       * @return       */      @Select("select count(*) from user ")      int findTotalUser();  }

3.2.3 編寫 SqlMapConfig 配置文件

<?xml version="1.0" encoding="UTF-8"?>  <!DOCTYPE configuration          PUBLIC "-//mybatis.org//DTD Config 3.0//EN"          "http://mybatis.org/dtd/mybatis-3-config.dtd">  <configuration>      <!-- 引入外部配置文件-->      <properties resource="jdbcConfig.properties"></properties>      <!--配置開啟二級快取-->      <settings>          <setting name="cacheEnabled" value="true"/>      </settings>        <!--配置別名-->      <typeAliases>          <package name="com.itheima.domain"></package>      </typeAliases>      <!-- 配置環境-->      <environments default="mysql">          <environment id="mysql">              <transactionManager type="JDBC"></transactionManager>              <dataSource type="POOLED">                  <property name="driver" value="${jdbc.driver}"></property>                  <property name="url" value="${jdbc.url}"></property>                  <property name="username" value="${jdbc.username}"></property>                  <property name="password" value="${jdbc.password}"></property>              </dataSource>          </environment>      </environments>      <!-- 指定帶有註解的dao介面所在位置 -->      <mappers>         <package name="com.itheima.dao"></package>      </mappers>  </configuration>

3.2.4 編寫測試方法

public class MybatisAnnotationCRUDTest {  	/**  	 * 測試查詢所有  	 */  	@Test  	public void testFindAll() {  		List < User > users = userDao.findAll();  		for (User user: users) {  			System.out.println(user);  		}  	}  	/**  	 * 測試查詢一個  	 */  	@Test  	public void testFindById() {  		User user = userDao.findById(41);  		System.out.println(user);  	}  	/**  	 * 測試保存  	 */  	@Testpublic void testSave() {  		User user = new User();  		user.setUserName("mybatis annotation");  		user.setUserSex("男");  		user.setUserAddress("北京市順義區");  		user.setUserBirthday(new Date());  		int res = userDao.saveUser(user);  		System.out.println("影響資料庫記錄的行數：" + res);  		System.out.println("插入的主鍵值：" + user.getUserId());  	}  	/**  	 * 測試更新  	 */  	@Test  	public void testUpdate() {  		User user = userDao.findById(63);  		user.setUserBirthday(new Date());  		user.setUserSex("女");  		int res = userDao.updateUser(user);  		System.out.println(res);  	}  	/**  	 * 測試刪除  	 */  	@Test  	public void testDelete() {  		int res = userDao.deleteUser(63);  		System.out.println(res);  	}  	/**  	 * 測試查詢使用聚合函數  	 */  	@Test  	public void testFindTotal() {  		int res = userDao.findTotal();  		System.out.println(res);  	}  	/**  	 * 測試模糊查詢  	 */  	@Test  	public void testFindByName() {  		List < User > users = userDao.findByName("%m%");  		for (User user: users) {  			System.out.println(user);  		}  	}  	private InputStream in ;  	private SqlSessionFactory factory;  	private SqlSession session;  	private IUserDao userDao;  	@Before //junit 的註解  	public void init() throws Exception {  		//1.讀取配置文件  		in = Resources.getResourceAsStream("SqlMapConfig.xml");  		//2.創建工廠  		SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();  		factory = builder.build( in );  		//3.創建 session  		session = factory.openSession();  		//4.創建代理對象  		userDao = session.getMapper(IUserDao.class);  	}  	@After //junit 的註解  	public void destroy() throws Exception {  		//提交事務  		session.commit();  		//釋放資源  		session.close();  		//關閉流  		in .close();  	}  }

3.3 使用註解實現複雜關係映射開發

實現複雜關係映射之前我們可以在映射文件中通過配置來實現，在使用註解開發時我們需要藉助@Results 註解，@Result 註解，@One 註解，@Many 註解。

3.3.1 複雜關係映射的註解說明

@Results 註解  代替的是標籤<resultMap>  該註解中可以使用單個@Result 註解，也可以使用@Result 集合  @Results（{@Result（），@Result（）}）或@Results（@Result（））  @Resutl 註解  代替了 <id>標籤和<result>標籤  @Result 中 屬性介紹：  id 是否是主鍵欄位  column 資料庫的列名  property 需要裝配的屬性名  one 需要使用的@One 註解（@Result（one=@One）（）））  many 需要使用的@Many 註解（@Result（many=@many）（）））  @One 註解（一對一）  代替了<assocation>標籤，是多表查詢的關鍵，在註解中用來指定子查詢返回單一對象。  @One 註解屬性介紹：  select 指定用來多表查詢的 sqlmapper  fetchType 會覆蓋全局的配置參數 lazyLoadingEnabled。。  使用格式：  @Result(column=" ",property="",one=@One(select=""))  @Many 註解（多對一）  代替了<Collection>標籤,是是多表查詢的關鍵，在註解中用來指定子查詢返回對象集合。  注意：聚集元素用來處理「一對多」的關係。需要指定映射的 Java 實體類的屬性，屬性的 javaType  （一般為 ArrayList）但是註解中可以不定義；  使用格式：  @Result(property="",column="",many=@Many(select=""))

3.3.2 使用註解實現一對一複雜關係映射及延遲載入

需求： 載入賬戶資訊時並且載入該賬戶的用戶資訊，根據情況可實現延遲載入。（註解方式實現）

3.3.2.1 添加 User 實體類及 Account 實體類

public class User implements Serializable {        private Integer id;      private String username;      private String address;      private String sex;      private Date birthday;        //一對多關係映射：主表實體應該包含從表實體的集合引用      private List<Account> accounts;        public List<Account> getAccounts() {          return accounts;      }        public void setAccounts(List<Account> accounts) {          this.accounts = accounts;      }        public Integer getId() {          return id;      }        public void setId(Integer id) {          this.id = id;      }        public String getUsername() {          return username;      }        public void setUsername(String username) {          this.username = username;      }        public String getAddress() {          return address;      }        public void setAddress(String address) {          this.address = address;      }        public String getSex() {          return sex;      }        public void setSex(String sex) {          this.sex = sex;      }        public Date getBirthday() {          return birthday;      }        public void setBirthday(Date birthday) {          this.birthday = birthday;      }        @Override      public String toString() {          return "User{" +                  "id=" + id +                  ", username='" + username + ''' +                  ", address='" + address + ''' +                  ", sex='" + sex + ''' +                  ", birthday=" + birthday +                  '}';      }  }

public class Account implements Serializable {        private Integer id;      private Integer uid;      private Double money;        //從表實體應該包含一個主表實體的對象引用      private User user;        public User getUser() {          return user;      }        public void setUser(User user) {          this.user = user;      }        public Integer getId() {          return id;      }        public void setId(Integer id) {          this.id = id;      }        public Integer getUid() {          return uid;      }        public void setUid(Integer uid) {          this.uid = uid;      }        public Double getMoney() {          return money;      }        public void setMoney(Double money) {          this.money = money;      }        @Override      public String toString() {          return "Account{" +                  "id=" + id +                  ", uid=" + uid +                  ", money=" + money +                  '}';      }  }

3.3.2.2 添加賬戶的持久層介面並使用註解配置

public interface IAccountDao {        /**       * 查詢所有賬戶，同時還要獲取到當前賬戶的所屬用戶資訊       * @return       */      List<Account> findAll();        /**       * 根據用戶id查詢賬戶資訊       * @param uid       * @return       */      List<Account> findAccountByUid(Integer uid);    }

3.3.2.3 添加用戶的持久層介面並使用註解配置

public interface IUserDao {        /**       * 查詢所有用戶，同時獲取到用戶下所有賬戶的資訊       * @return       */      List<User> findAll();          /**       * 根據id查詢用戶資訊       * @param userId       * @return       */      User findById(Integer userId);        /**       * 更新用戶資訊       * @param user       */      void updateUser(User user);  }

3.3.2.4 測試一對一關聯及延遲載入

public class AccountTest {  	@Test  	public void testFindAll() {  		List < Account > accounts = accountDao.findAll();  		// for(Account account : accounts) {  		// System.out.println(account);  		// System.out.println(account.getUser());  	}  }

3.3.3 使用註解實現一對多複雜關係映射

需求： 查詢用戶資訊時，也要查詢他的賬戶列表。使用註解方式實現。

分析： 一個用戶具有多個賬戶資訊，所以形成了用戶(User)與賬戶(Account)之間的一對多關係。

3.3.3.1 User 實體類加入 List<Account>

public class User implements Serializable {        private Integer id;      private String username;      private String address;      private String sex;      private Date birthday;        //一對多關係映射：主表實體應該包含從表實體的集合引用      private List<Account> accounts;        public List<Account> getAccounts() {          return accounts;      }        public void setAccounts(List<Account> accounts) {          this.accounts = accounts;      }        public Integer getId() {          return id;      }        public void setId(Integer id) {          this.id = id;      }        public String getUsername() {          return username;      }        public void setUsername(String username) {          this.username = username;      }        public String getAddress() {          return address;      }        public void setAddress(String address) {          this.address = address;      }        public String getSex() {          return sex;      }        public void setSex(String sex) {          this.sex = sex;      }        public Date getBirthday() {          return birthday;      }        public void setBirthday(Date birthday) {          this.birthday = birthday;      }        @Override      public String toString() {          return "User{" +                  "id=" + id +                  ", username='" + username + ''' +                  ", address='" + address + ''' +                  ", sex='" + sex + ''' +                  ", birthday=" + birthday +                  '}';      }  }

3.3.3.2 編寫用戶的持久層介面並使用註解配置

public interface IUserDao {        /**       * 查詢所有用戶，同時獲取到用戶下所有賬戶的資訊       * @return       */      List<User> findAll();          /**       * 根據id查詢用戶資訊       * @param userId       * @return       */      User findById(Integer userId);      }

3.3.3.3 編寫賬戶的持久層介面並使用註解配置

public interface IAccountDao {        /**       * 查詢所有賬戶，同時還要獲取到當前賬戶的所屬用戶資訊       * @return       */      List<Account> findAll();        /**       * 根據用戶id查詢賬戶資訊       * @param uid       * @return       */      List<Account> findAccountByUid(Integer uid);    }

3.3.3.4 添加測試方法

public class UserTest {  	/**  	 * 測試查詢所有  	 */  	@Test  	public void testFindAll() {  		List < User > users = userDao.findAll();  		// for(User user : users) {  		// System.out.println("-----每個用戶的內容-----");  		// System.out.println(user);  		// System.out.println(user.getAccounts());  		// } }  		private InputStream in ;  		private SqlSessionFactory factory;  		private SqlSession session;  		private IUserDao userDao;  		@Before //junit 的註解  		public void init() throws Exception {  			//1.讀取配置文件  			in = Resources.getResourceAsStream("SqlMapConfig.xml");  			//2.創建工廠  			SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();  			factory = builder.build( in );  			//3.創建 session  			session = factory.openSession(); //4.創建代理對象  			userDao = session.getMapper(IUserDao.class);  		}  		@After //junit 的註解  		public void destroy() throws Exception {  			//提交事務  			session.commit();  			//釋放資源  			session.close();  			//關閉流  			in .close();  		}  	}

3.4 mybatis 基於註解的二級快取

3.4.1 在 SqlMapConfig 中開啟二級快取支援

<!-- 配置二級快取 -->  <settings>  	<!-- 開啟二級快取的支援 -->  	<setting name="cacheEnabled" value="true"/>  </settings>

3.4.2 在持久層介面中使用註解配置二級快取

@CacheNamespace(blocking=true)//mybatis 基於註解方式實現配置二級快取  public interface IUserDao {}