前面介紹了Spring Boot 整合mybatis 使用注解的方式實(shí)現(xiàn)數(shù)據(jù)庫操作，介紹了如何自動(dòng)生成注解版的mapper 和pojo類。 接下來介紹使用mybatis 常用注解以及如何傳參數(shù)等數(shù)據(jù)庫操作中的常用操作。

其實(shí)，mybatis 注解方式 和 XML配置方式兩者的使用基本上相同，只有在構(gòu)建 SQL 腳本有所區(qū)別，所以這里重點(diǎn)介紹兩者之間的差異，以及增刪改查，參數(shù)傳遞等注解的常用操作。

詳解SpringBoot 快速整合Mybatis（去XML化+注解進(jìn)階)已經(jīng)介紹過了，不清楚的朋友可以看看之前的文章：https://www.jb51.net/article/127473.htm

注解介紹

mybatis 注解方式的最大特點(diǎn)就是取消了Mapper的XML配置，具體的 SQL 腳本直接寫在 Mapper 類或是 SQLProvider 中的方法動(dòng)態(tài)生成。 mybatis 提供的常用注解有：@Insert 、@Update 、@Select、 @Delete等標(biāo)簽，這些注解其實(shí)就是 MyBatis 提供的來取代其 XML配置文件的。

1、@Select 注解

@Select，主要在查詢的時(shí)候使用，查詢類的注解，一般簡單的查詢可以使用這個(gè)注解。

@Select({ 'select', 'id, company_id, username, password, nickname, age, sex, job, face_image, province, ', 'city, district, address, auth_salt, last_login_ip, last_login_time, is_delete, ', 'regist_time', 'from sys_user', 'where id = #{id,jdbcType=VARCHAR}'})@Results({ @Result(column='id', property='id', jdbcType=JdbcType.VARCHAR, id=true), @Result(column='company_id', property='companyId', jdbcType=JdbcType.VARCHAR), @Result(column='face_image', property='faceImage', jdbcType=JdbcType.VARCHAR), @Result(column='auth_salt', property='authSalt', jdbcType=JdbcType.VARCHAR), @Result(column='last_login_ip', property='lastLoginIp', jdbcType=JdbcType.VARCHAR), @Result(column='last_login_time', property='lastLoginTime', jdbcType=JdbcType.TIMESTAMP), @Result(column='is_delete', property='isDelete', jdbcType=JdbcType.INTEGER), @Result(column='regist_time', property='registTime', jdbcType=JdbcType.TIMESTAMP)})User selectByPrimaryKey(String id);

注意：如果是多個(gè)參數(shù)，需要將 #后面的參數(shù)和傳入的變量名保持一致。

2、@Insert 注解

@Insert，插入數(shù)據(jù)時(shí)使用，直接傳入數(shù)據(jù)實(shí)體類，mybatis 會(huì)屬性自動(dòng)解析到對(duì)應(yīng)的參數(shù)。所以需要將 #后面的參數(shù)和實(shí)體類屬性保持一致。

@Insert({ 'insert into sys_user (id, company_id, ', 'username, password, ', 'nickname, age, sex, ', 'job, face_image, ', 'province, city, ', 'district, address, ', 'auth_salt, last_login_ip, ', 'last_login_time, is_delete, ', 'regist_time)', 'values (#{id,jdbcType=VARCHAR}, #{companyId,jdbcType=VARCHAR}, ', '#{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR}, ', '#{nickname,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER}, #{sex,jdbcType=INTEGER}, ', '#{job,jdbcType=INTEGER}, #{faceImage,jdbcType=VARCHAR}, ', '#{province,jdbcType=VARCHAR}, #{city,jdbcType=VARCHAR}, ', '#{district,jdbcType=VARCHAR}, #{address,jdbcType=VARCHAR}, ', '#{authSalt,jdbcType=VARCHAR}, #{lastLoginIp,jdbcType=VARCHAR}, ', '#{lastLoginTime,jdbcType=TIMESTAMP}, #{isDelete,jdbcType=INTEGER}, ', '#{registTime,jdbcType=TIMESTAMP})' }) int insert(User record);

注意：需要將 #后面的參數(shù)和實(shí)體類屬性保持一致。

3、@Update 注解

@Update，一般數(shù)據(jù)更新操作可以使用 @Update注解實(shí)現(xiàn)。

@Update({ 'update sys_user', 'set company_id = #{companyId,jdbcType=VARCHAR},', 'username = #{username,jdbcType=VARCHAR},', 'password = #{password,jdbcType=VARCHAR},', 'nickname = #{nickname,jdbcType=VARCHAR},', 'age = #{age,jdbcType=INTEGER},', 'sex = #{sex,jdbcType=INTEGER},', 'job = #{job,jdbcType=INTEGER},', 'face_image = #{faceImage,jdbcType=VARCHAR},', 'province = #{province,jdbcType=VARCHAR},', 'city = #{city,jdbcType=VARCHAR},', 'district = #{district,jdbcType=VARCHAR},', 'address = #{address,jdbcType=VARCHAR},', 'auth_salt = #{authSalt,jdbcType=VARCHAR},', 'last_login_ip = #{lastLoginIp,jdbcType=VARCHAR},', 'last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP},', 'is_delete = #{isDelete,jdbcType=INTEGER},', 'regist_time = #{registTime,jdbcType=TIMESTAMP}', 'where id = #{id,jdbcType=VARCHAR}' }) int updateByPrimaryKey(User record);

4、@Delete 注解@Delete 數(shù)據(jù)刪除的注解

@Delete({ 'delete from sys_user', 'where id = #{id,jdbcType=VARCHAR}' }) int deleteByPrimaryKey(String id);

5、@Results和@Result注解

@Results 和 @Result 主要作用是，當(dāng)有一些特殊的場(chǎng)景需要處理，查詢的返回結(jié)果與期望的數(shù)據(jù)格式不一致時(shí)，可以將將數(shù)據(jù)庫中查詢到的數(shù)值自動(dòng)轉(zhuǎn)化為具體的屬性或類型，，修飾返回的結(jié)果集。比如查詢的對(duì)象返回值屬性名和字段名不一致，或者對(duì)象的屬性中使用了枚舉等。如果實(shí)體類屬性和數(shù)據(jù)庫屬性名保持一致，就不需要這個(gè)屬性來修飾。

@Select({ 'select', 'id, company_id, username, password, nickname, age, sex, job, face_image, province, ', 'city, district, address, auth_salt, last_login_ip, last_login_time, is_delete, ', 'regist_time', 'from sys_user', 'where id = #{id,jdbcType=VARCHAR}'})@Results({ @Result(column='id', property='id', jdbcType=JdbcType.VARCHAR, id=true), @Result(column='company_id', property='companyId', jdbcType=JdbcType.VARCHAR), @Result(column='face_image', property='faceImage', jdbcType=JdbcType.VARCHAR), @Result(column='auth_salt', property='authSalt', jdbcType=JdbcType.VARCHAR), @Result(column='last_login_ip', property='lastLoginIp', jdbcType=JdbcType.VARCHAR), @Result(column='last_login_time', property='lastLoginTime', jdbcType=JdbcType.TIMESTAMP), @Result(column='is_delete', property='isDelete', jdbcType=JdbcType.INTEGER), @Result(column='regist_time', property='registTime', jdbcType=JdbcType.TIMESTAMP)})User selectByPrimaryKey(String id);

上面的例子可以看到，數(shù)據(jù)庫中的company_id 字段和實(shí)體類中定義的 companyId 屬性的名稱不一致，需要Result 轉(zhuǎn)換。

以上就是項(xiàng)目中常用的增、刪、改、查的操作， 其實(shí)這些在基本的方法不需要手動(dòng)寫，用前面講過的mybatis generator 自動(dòng)生成即可。講這些主要是熟悉這些常用的注解。

傳參方式

上面介紹了mybatis 常用的注解，如何實(shí)現(xiàn)增刪改查的操作，相信很多人會(huì)有疑問了： mybatis 是如何將參數(shù)傳遞到 SQL 中的呢，都有哪幾種傳參方式呢？ 下面就來一一介紹mybatis 注解版的傳參方式。

1、直接傳參

對(duì)于單個(gè)參數(shù)的方法，可直接使用 #{id} 的方式接收同名的變量參數(shù)。

@Delete('delete from sys_user where id = #{id,jdbcType=VARCHAR}')int deleteByPrimaryKey(String id);

2、使用@Param 注解

@Param注解的作用是給參數(shù)命名，參數(shù)命名后就能根據(jù)名字得到參數(shù)值，正確的將參數(shù)傳入sql語句中 。如果你的方法有多個(gè)參數(shù)，@Param注解 會(huì)在方法的參數(shù)上就能為它們?nèi)∽远x名字，參數(shù)則先以 'param' 作前綴，再加上它們的參數(shù)位置作為參數(shù)別名。例如， #{param1}、 #{param2}，這個(gè)是默認(rèn)值。如果注解是 @Param('person')，那么參數(shù)就會(huì)被命名為 #{person}。

@Select('SELECT * FROM sys_user WHERE username = #{username} and password = #{password}')List<User> getListByUserSex(@Param('username') String userName, @Param('password') String password);// 不自定義param 時(shí)，默認(rèn)使用 param + 參數(shù)序號(hào) 或者 0，1，值就是參數(shù)的值。@Select('SELECT * FROM sys_user WHERE username = #{param1} and password = #{param2}')List<User> getListByUserSex(String userName, String password);

3、Map 傳值需要傳送多個(gè)參數(shù)時(shí)，也可以考慮使用Map的形式。

@Select('SELECT * FROM sys_user WHERE username=#{username} AND password = #{password}')List<User> getListByNameAndSex(Map<String, Object> map);

調(diào)用時(shí)將參數(shù)依次加入到 Map 中即可。

Map param= new HashMap();param.put('username','admin');param.put('password','123456');List<User> users = userMapper.getListByNameAndSex(param)

4、使用pojo對(duì)象 使用pojo對(duì)象傳參是比較常用的傳參方式。像上面的insert、update 等方法。都是直接傳入user對(duì)象。

@Update({ 'update sys_user', 'set company_id = #{companyId,jdbcType=VARCHAR},', 'username = #{username,jdbcType=VARCHAR},', 'password = #{password,jdbcType=VARCHAR},', 'nickname = #{nickname,jdbcType=VARCHAR},', 'age = #{age,jdbcType=INTEGER},', 'sex = #{sex,jdbcType=INTEGER},', 'job = #{job,jdbcType=INTEGER},', 'face_image = #{faceImage,jdbcType=VARCHAR},', 'province = #{province,jdbcType=VARCHAR},', 'city = #{city,jdbcType=VARCHAR},', 'district = #{district,jdbcType=VARCHAR},', 'address = #{address,jdbcType=VARCHAR},', 'auth_salt = #{authSalt,jdbcType=VARCHAR},', 'last_login_ip = #{lastLoginIp,jdbcType=VARCHAR},', 'last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP},', 'is_delete = #{isDelete,jdbcType=INTEGER},', 'regist_time = #{registTime,jdbcType=TIMESTAMP}', 'where id = #{id,jdbcType=VARCHAR}'})int updateByPrimaryKey(User record);

以上，就是Mybatis 傳參的四種方式。根據(jù)方法的參數(shù)選擇合適的傳值方式。

動(dòng)態(tài) SQL

實(shí)際項(xiàng)目中，除了使用一些常用的增刪改查的方法之外，有些復(fù)雜的需求，可能還需要執(zhí)行一些自定義的動(dòng)態(tài)sql。mybatis 除了提供了@Insert、@Delete 這些常用的注解，還提供了多個(gè)注解如：@InsertProvider,@UpdateProvider,@DeleteProvider和@SelectProvider，用來建立動(dòng)態(tài)sql 和讓 mybatis 執(zhí)行這些sql 的注解。下面就來實(shí)現(xiàn)按字段更新的功能。

1、首先在 UserSqlProvider 中創(chuàng)建 拼接sql的方法。

public String updateByPrimaryKeySelective(User record) { BEGIN(); UPDATE('sys_user'); if (record.getCompanyId() != null) { SET('company_id = #{companyId,jdbcType=VARCHAR}'); } if (record.getUsername() != null) { SET('username = #{username,jdbcType=VARCHAR}'); } if (record.getPassword() != null) { SET('password = #{password,jdbcType=VARCHAR}'); } if (record.getNickname() != null) { SET('nickname = #{nickname,jdbcType=VARCHAR}'); } if (record.getAge() != null) { SET('age = #{age,jdbcType=INTEGER}'); } if (record.getSex() != null) { SET('sex = #{sex,jdbcType=INTEGER}'); } if (record.getJob() != null) { SET('job = #{job,jdbcType=INTEGER}'); } if (record.getFaceImage() != null) { SET('face_image = #{faceImage,jdbcType=VARCHAR}'); } if (record.getProvince() != null) { SET('province = #{province,jdbcType=VARCHAR}'); } if (record.getCity() != null) { SET('city = #{city,jdbcType=VARCHAR}'); } if (record.getDistrict() != null) { SET('district = #{district,jdbcType=VARCHAR}'); } if (record.getAddress() != null) { SET('address = #{address,jdbcType=VARCHAR}'); } if (record.getAuthSalt() != null) { SET('auth_salt = #{authSalt,jdbcType=VARCHAR}'); } if (record.getLastLoginIp() != null) { SET('last_login_ip = #{lastLoginIp,jdbcType=VARCHAR}'); } if (record.getLastLoginTime() != null) { SET('last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP}'); } if (record.getIsDelete() != null) { SET('is_delete = #{isDelete,jdbcType=INTEGER}'); } if (record.getRegistTime() != null) { SET('regist_time = #{registTime,jdbcType=TIMESTAMP}'); } WHERE('id = #{id,jdbcType=VARCHAR}'); return SQL(); }

2、Mapper 中引入updateByPrimaryKeySelective方法

@UpdateProvider(type=UserSqlProvider.class, method='updateByPrimaryKeySelective') int updateByPrimaryKeySelective(User record);

說明：

type：動(dòng)態(tài)⽣成 SQL 的類

method：類中具體的方法名

以上，就是使用sqlprovider 動(dòng)態(tài)創(chuàng)建sql，除了示例中的@UpdateProvider ，，還有 @InsertProvider、 @SelectProvider、@DeleteProvider 提供給插入、查詢、刪除的時(shí)使用。

最后

上面，介紹了使用mybatis 常用注解實(shí)現(xiàn)增、刪、改、查。以及mybatis 常用的四種參數(shù)傳遞方式。

到此這篇關(guān)于Spring Boot整合mybatis使用注解實(shí)現(xiàn)動(dòng)態(tài)Sql、參數(shù)傳遞等常用操作(實(shí)現(xiàn)方法)的文章就介紹到這了,更多相關(guān)Spring Boot整合mybatis內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！