2. 程式人生 > >【MyBatis學習18】使用註解配置Mapper

【MyBatis學習18】使用註解配置Mapper

阿新 • • 發佈：2019-01-08

MyBatis支援使用註解來配置對映的sql語句，這樣可以省掉對映器xml檔案。

一、對映語句

1、insert 
比如入門例項中的：

public int insert(User user) throws Exception;
  • 1
  • 1
<insert id="insert"  parameterType="twm.mybatisdemo.pojo.User" useGeneratedKeys="true" keyProperty="id">
    <!-- 將插入資料的主鍵返回，返回到user物件中 -->
    insert into user (username,address,email) values (#{username},#{address},#{email})
</insert
 
>
  • 1
  • 2
  • 3
  • 4
  • 1
  • 2
  • 3
  • 4

改成註解來配置對映：

@Insert("insert into user (username,address,email) values (#{username},#{address},#{email})")
@Options(useGeneratedKeys = true, keyProperty = "id") 
public int insert(User user) throws Exception;
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

這裡使用@Insert註解來定義一個INSERT對映語句。 
並且使用@Options註解的userGeneratedKeys 和keyProperty

屬性，讓資料庫auto_increment生成的主鍵值，賦值到keyProperty標記的屬性id中

還有一種獲取主鍵的方法（Oracle要用SELECT SEQ.NEXTVAL FROM DUAL ，且order設為before）

<insert id="insert"  parameterType="twm.mybatisdemo.pojo.User" >
    <!-- 將插入資料的主鍵返回，返回到user物件中 -->
    <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer"
 
>
           select last_insert_id()
    </selectKey>
    insert into user (username,address,email) values (#{username},#{address},#{email})
</insert>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

相應的註解是：

@Insert("insert into user (username,address,email) values (#{username},#{address},#{email})")
@SelectKey(statement="select last_insert_id()",keyProperty="id", resultType=int.class, before=true)
public int insert(User user) throws Exception;
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

2、select

@Select("select * from user where id=#{id}")
public User selectById(int id) throws Exception;
  • 1
  • 2
  • 1
  • 2

返回的是一個User物件，因此如果select語句返回多行記錄，就會出現TooManyResultsException異常。

3、update

@Update("update user set username=#{username},address=#{address},email=#{email} where id=#{id}")
public int update(User user) throws Exception;
  • 1
  • 2
  • 1
  • 2

4、delete

@Delete("delete from user where id=#{id}")
public int delete(int id) throws Exception;
  • 1
  • 2
  • 1
  • 2

二、結果對映

在xml配置檔案中，將查詢結果和JavaBean屬性對映起來的標籤是<resultMap>。對應的是@Results註解

@Select("select * from user")
@Results({ @Result(id = true, column = "id", property = "id"),
        @Result(column = "username", property = "user_name"),
        @Result(column = "city", property = "city") })
public List<User> selectAll() throws Exception;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 1
  • 2
  • 3
  • 4
  • 5

@Results註解沒辦法複用。譬如我們的public User selectById(int id) throws Exception也要用到同樣的@Results註解，但還是要重新寫一個一模一樣的@Results

@Select("select * from user where id=#{id}")
@Results({ @Result(id = true, column = "id", property = "id"),
        @Result(column = "username", property = "user_name"),
        @Result(column = "city", property = "city") })
public User selectById(int id) throws Exception;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 1
  • 2
  • 3
  • 4
  • 5

如果要想使用可以複用的對映器，那麼就使用@ResultMap註解。該註解依賴一個xml配置檔案。 
在介面檔案同目錄下新建一個userMapper.xml檔案，並定義一個名為userMap的resultMap。

<mapper namespace="twm.mybatisdemo.mapper.UserMapper">
    <!-- 自定義返回結果集 -->
    <resultMap id="userMap" type="twm.mybatisdemo.pojo.User">
        <id column="id" property="id" jdbcType="INTEGER" />
        <result property="user_name" column="username"></result>
        <result property="city" column="city"></result>
    </resultMap>
</mapper>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

在userMapper.Java中，使用@ResultMap引用名為userMap的resultMap，實現複用。

@Select("select * from user where id=#{id}")  
@ResultMap("twm.mybatisdemo.mapper.UserMapper.userMap")  
public User selectById(int id) throws Exception;

@Select("select * from user")  
@ResultMap("twm.mybatisdemo.mapper.UserMapper.userMap")  
public List<User> selectAll() throws Exception;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

三、關聯關係

1、一對一關係 
MyBatis提供了@One註解來配合@Result註解，從而實現一對一關聯查詢資料的載入。 
比如所有user物件都有個配偶資訊spouse(本例中配偶本身也是一個user物件)

@Select("select * from user")
@Results({ @Result(id = true, column = "id", property = "id"),
        @Result(column = "username", property = "user_name"),
        @Result(column = "city", property = "city"),
        @Result(column = "account_id", property = "account",one = @One(select = "twm.mybatisdemo.mapper.AccountMapper.selectById")) })
public List<User> selectAll() throws Exception;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

在這裡column = "account_id"指定了向twm.mybatisdemo.mapper.AccountMapper.selectById方法傳遞的引數。如果@OneSELECT查詢返回了多行結果，則會丟擲TooManyResultsException異常。

呼叫:

UserMapper userMapper =sqlSession.getMapper(UserMapper.class);  
List<User> userlist = userMapper.selectAll();  
System.out.println(userlist[0].getAccount().getBalance());
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

如果結果對映使用的是xml檔案,那麼可以association 來配置對映：

<mapper namespace="twm.mybatisdemo.mapper.UserMapper">
    <!-- 自定義返回結果集 -->
    <resultMap id="userMapWithAccount" type="twm.mybatisdemo.pojo.User">
        <id column="id" property="id" jdbcType="INTEGER" />
        <result property="user_name" column="username"></result>
        <result property="city" column="city"></result>
        <association property="account" javaType="Account" column="account_id" 
            select="twm.mybatisdemo.mapper.AccountMapper.selectById" />
    </resultMap>
</mapper>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

介面如下：

@Select("select * from user")
@ResultMap("twm.mybatisdemo.mapper.UserMapper.userMapWithAccount")
public List<User> selectAll() throws Exception;
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

2、一對多關係 
MyBatis提供了@Many註解來配合@Result註解，從而實現一對多關聯查詢資料的載入。 
現在讓我們看一下如何使用@Many註解獲取一個講師及其教授課程列表資訊：

public interface TutorMapper
{
    @Select("select * from courses where tutor_id=#{tutorId}")
    @Results(
    {
        @Result(id = true, column = "course_id", property = "courseId"),
        @Result(column = "name", property = "name"),
        @Result(column = "description", property = "description"),
        @Result(column = "start_date" property = "startDate"),
        @Result(column = "end_date" property = "endDate")
    })
    List<Course> findCoursesByTutorId(int tutorId);

    @Select("SELECT tutor_id, name as tutor_name, email, addr_id
            FROM tutors where tutor_id=#{tutorId}")
    @Results(
    {
        @Result(id = true, column = "tutor_id", property = "tutorId"),
        @Result(column = "tutor_name", property = "name"),
        @Result(column = "email", property = "email"),
        @Result(property = "address", column = "addr_id",
        one = @One(select = " com.mybatis3.
        mappers.TutorMapper.findAddressById")),
        @Result(property = "courses", column = "tutor_id",
        many = @Many(select = "com.mybatis3.mappers.TutorMapper.
        findCoursesByTutorId"))
    })
    Tutor findTutorById(int tutorId);
}
  • 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
  • 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

同樣也可以採用配置xml中配置resultMaps的方式

<mapper namespace="com.mybatis3.mappers.TutorMapper">
    <resultMap type="Course" id="CourseResult">
        <id column="course_id" property="courseId" />
        <result column="name" property="name" />
        <result column="description" property="description" />
        <result column="start_date" property="startDate" />
        <result column="end_date" property="endDate" />
    </resultMap>
    <resultMap type="Tutor" id="TutorResult">
        <id column="tutor_id" property="tutorId" />
        <result column="tutor_name" property="name" />
        <result column="email" property="email" />
        <collection property="courses" resultMap="CourseResult" />
    </resultMap>
</mapper>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
public interface TutorMapper
{
    @Select("SELECT T.TUTOR_ID, T.NAME AS TUTOR_NAME, EMAIL,
            A.ADDR_ID, STREET, CITY, STATE, ZIP, COUNTRY, COURSE_ID, C.NAME,
            DESCRIPTION, START_DATE, END_DATE  FROM TUTORS T LEFT OUTER
            JOIN ADDRESSES A ON T.ADDR_ID=A.ADDR_ID LEFT OUTER JOIN COURSES
            C ON T.TUTOR_ID=C.TUTOR_ID WHERE T.TUTOR_ID=#{tutorId}")
    @ResultMap("com.mybatis3.mappers.TutorMapper.TutorResult")
    Tutor selectTutorById(int tutorId);
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

四、動態SQL

MyBatis提供了各種註解如@InsertProvider,@UpdateProvider,@DeleteProvider和@SelectProvider，來幫助構建動態SQL語句，然後讓MyBatis執行這些SQL語句。

這裡重點用@SelectProvider舉例：

建立一個TutorDynaSqlProvider.java類，以及findTutorByIdSql()方法，如下所示：

package com.mybatis3.sqlproviders;
import org.apache.ibatis.jdbc.SQL;
public class TutorDynaSqlProvider
{
    public String findTutorByIdSql(int tutorId)
    {
        return "SELECT TUTOR_ID AS tutorId, NAME, EMAIL FROM TUTORS
               WHERE TUTOR_ID=" + tutorId;
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

在TutorMapper.java介面中建立一個對映語句，如下：

@SelectProvider(type=TutorDynaSqlProvider.class, method="findTutorByIdSql")  
Tutor findTutorById(int tutorId);
  • 1
  • 2
  • 1
  • 2

相關推薦

【MyBatis學習18】使用註解配置Mapper

MyBatis支援使用註解來配置對映的sql語句，這樣可以省掉對映器xml檔案。 一、對映語句 1、insert  比如入門例項中的： public int insert(User user) throws Exception;11<insert id="in

【Mybatis學習筆記】01 配置搭建Mybatis

一、什麼是Mybatis mybatis是對jdbc的封裝 將sql語句放在對映檔案中（xml） 自動將輸入引數對映到sql語句的動態引數上自動將sql語句執行的結果對映成java物件。二、入門例項1、建立專案mybatis-01java專案maven2.匯入jar包![im

【MyBatis學習筆記】5：認識使用typeHandlers配置型別處理器

簡述 註冊了的型別處理器會用於處理下面兩種情形： 為PreparedStatement設定一個引數，將引數從Java型別轉為JDBC型別。 從ResultSet中取出一個值，將結果從JDBC型別轉為Java型別。 型別處理器可分為以下兩類： MyB

【MyBatis學習05】SqlMapConfig.xml檔案中的配置總結

　　經過上兩篇博文的總結，對mybatis中的dao開發方法和流程基本掌握了，這一節主要來總結一下mybatis中的全域性配置檔案SqlMapConfig.xml在開發中的一些常用配置，首先看一下該全域性配置檔案中都有哪些可以配置的東西： 配置內容 作用 <

【MyBatis學習04】mapper代理方法開發dao

　　上一篇博文總結了mybatis使用 原始dao的方法存在的一些弊端，我們肯定不會去用它，那麼mybatis中該如何開發dao呢？如題所述，這篇博文主要來總結一下使用mapper代理的方法來開發d

【SSH學習筆記】—從配置Struts1環境到簡單實例

swa void tro 介紹 -s exceptio art error con 以下我將從一個簡單點的計算器實例，介紹struts1的環境配置，以及其重要的兩個核心類：ActionForm和Action 簡單計算器實現思路: 1.提供一個輸入界面，

【MyBatis學習15】使用MyBatis Generator自動建立程式碼

這兩天需要用到MyBatis的程式碼自動生成的功能，由於MyBatis屬於一種半自動的ORM框架，所以主要的工作就是配置Mapping對映檔案，但是由於手寫對映檔案很容易出錯，所以可利用MyBatis生成器自動生成實體類、DAO介面和Mapping對映檔案。這樣可以省去很多的功夫，將生成的程

【Mybatis學習筆記】01—Mybatis入門

什麼是Mybatis: Mybatis是一款持久層框架。用於程式與資料庫的之間的互動。 Mybatis和大名鼎鼎的全自動持久層框架Hibernate最大不同的地方在於,Mybatis是半自動的,由開發人員來定製sql語句。 並且相比較Hibernate而言Mybatis

【系統學習SpringBoot】SpringBoot配置logging日誌及輸出日誌

SpringBoot預設配置了【org.slf4j】，，所以配置日誌輸出到檔案只需要在，appliction配置檔案中稍作修改即可，， 加入如下配置（yml格式） #配置日誌 logging: #配置日誌檔案路徑 path: G:\work_

【Mybatis學習筆記】04 Mybatis分頁-多引數傳遞

2018.5.18需求：查詢分頁資料方法一：使用索引按照引數的順序，從0開始mapper:介面：引數名任意方法二：使用註解、mapper:介面：註解的value值要和mapper的佔位引數一致。方法三：使用map（常用）mapper中的引數佔位符要和測試中的map的key，v

【MyBatis學習07】輸出型別resultType及輸出引數對映resultMap

使用mybatis操作時，對於SQL語句返回結果的處理通常有兩種方式，一種是resultType，另一種是resultMap。 resultType：如果要填充的pojo屬性和資料庫列名完全一致，可採用resultType。如果出現不一致的情況下，系統並不

【MyBatis學習16】自定義型別處理器typeHandlers介紹

<update id="update" parameterType="twm.mybatisdemo.pojo.User"> update user set username=#{username},password=#{pa

【MyBatis學習10】高階對映之多對多查詢

　　本文來總結一下mybatis中的多對多對映，從第8節的文章中可以看出，使用者表和商品表示多對多關係，它們兩的多對多是通過訂單項和訂單明細這兩張表所關聯起來的，那麼這一節主要來總結一下使用者表和商

【MyBatis學習11】MyBatis中的延遲載入

1. 什麼是延遲載入 　　舉個例子：如果查詢訂單並且關聯查詢使用者資訊。如果先查詢訂單資訊即可滿足要求，當我們需要查詢使用者資訊時再查詢使用者資訊。把對使用者資訊的按需去查詢就是延遲載入。

【MyBatis學習8】MyBatis中的二級快取

1. 二級快取的原理 　　前面介紹了，mybatis中的二級快取是mapper級別的快取，值得注意的是，不同的mapper都有一個二級快取，也就是說，不同的mapper之間的二級快取是互不影響的。為了更加清楚的描述二級快取，先來看一個示意圖：   　　從圖中可以看出： sqlSession1去查詢使用

【MyBatis學習12】MyBatis中的一級快取

　　快取的作用是減輕資料庫的壓力，提高資料庫的效能的。mybatis中提供了一級快取和二級快取，先來看一下兩個快取的示意圖： 　　從圖中可以看出： 一級快取是SqlSession

【MyBatis學習10】關聯關係association：1對1關聯的三種方法

本篇主要講關聯關係：一對一關係與一對多關係。 先建5個表： DROP TABLE IF EXISTS `category`; CREATE TABLE `category` ( `id` int(10) unsigned NOT NULL A

【MyBatis學習06】_parameter：解決There is no getter for property named in class java.lang.String

我們知道在mybatis的對映中傳引數，只能傳入一個。通過#{引數名} 即可獲取傳入的值。 Mapper介面檔案: public int delete(int id) throws Exception; MapperL配置檔案: <dele

【MyBatis學習05】傳入引數parameterType

在前面的mapper.xml的select、insert、update、delete這些元素中，我們已接觸了傳入引數，並通過parameterType指定傳入引數的型別。注意不要和parameterMap混淆了。(parameterMap幾乎很少場景下用了)

【MyBatis學習17】用typeHandlers處理enum型別

如果想使用mybatis自帶的列舉類處理，有2種方式，一個是EnumTypeHandler，一個是EnumOrdinalTypeHandler。 區別如下: EnumTypeHandler直接儲存name值。它是mybatis預設的列舉型別轉換器。