文章詳情頁

Spring Boot整合mybatis使用注解實現動態Sql、參數傳遞等常用操作(實現方法)

瀏覽：233日期：2023-08-19 18:58:09

前面介紹了Spring Boot 整合mybatis 使用注解的方式實現數據庫操作，介紹了如何自動生成注解版的mapper 和pojo類。接下來介紹使用mybatis 常用注解以及如何傳參數等數據庫操作中的常用操作。

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

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

注解介紹

mybatis 注解方式的最大特點就是取消了Mapper的XML配置，具體的 SQL 腳本直接寫在 Mapper 類或是 SQLProvider 中的方法動態生成。 mybatis 提供的常用注解有：@Insert 、@Update 、@Select、 @Delete等標簽，這些注解其實就是 MyBatis 提供的來取代其 XML配置文件的。

1、@Select 注解

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

@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);

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

2、@Insert 注解

@Insert，插入數據時使用，直接傳入數據實體類，mybatis 會屬性自動解析到對應的參數。所以需要將 #后面的參數和實體類屬性保持一致。

@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);

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

3、@Update 注解

@Update，一般數據更新操作可以使用 @Update注解實現。

@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 數據刪除的注解

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

5、@Results和@Result注解

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

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

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

傳參方式

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

1、直接傳參

對于單個參數的方法，可直接使用 #{id} 的方式接收同名的變量參數。

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

2、使用@Param 注解

@Param注解的作用是給參數命名，參數命名后就能根據名字得到參數值，正確的將參數傳入sql語句中。如果你的方法有多個參數，@Param注解會在方法的參數上就能為它們取自定義名字，參數則先以 'param' 作前綴，再加上它們的參數位置作為參數別名。例如， #{param1}、 #{param2}，這個是默認值。如果注解是 @Param('person')，那么參數就會被命名為 #{person}。

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

3、Map 傳值需要傳送多個參數時，也可以考慮使用Map的形式。

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

調用時將參數依次加入到 Map 中即可。

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

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

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

動態 SQL

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

1、首先在 UserSqlProvider 中創建拼接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：動態⽣成 SQL 的類

method：類中具體的方法名

以上，就是使用sqlprovider 動態創建sql，除了示例中的@UpdateProvider ，，還有 @InsertProvider、 @SelectProvider、@DeleteProvider 提供給插入、查詢、刪除的時使用。

最后

上面，介紹了使用mybatis 常用注解實現增、刪、改、查。以及mybatis 常用的四種參數傳遞方式。

到此這篇關于Spring Boot整合mybatis使用注解實現動態Sql、參數傳遞等常用操作(實現方法)的文章就介紹到這了,更多相關Spring Boot整合mybatis內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！

Spring

上一條：從零搭建Spring Boot腳手架整合OSS作為文件服務器的詳細教程下一條：JavaEE SpringMyBatis是什么? 它和Hibernate的區別及如何配置MyBatis

相關文章：

1. IntelliJ IDEA安裝插件的方法步驟2. 通過Django Admin+HttpRunner1.5.6實現簡易接口測試平臺3. Docker 部署 Prometheus的安裝詳細教程4. IntelliJ IDEA設置自動提示功能快捷鍵的方法5. idea重置默認配置的方法步驟6. idea打開多個窗口的操作方法7. idea設置代碼格式化的方法步驟8. idea給項目打war包的方法步驟9. IntelliJ IDEA調整字體大小的方法10. IntelliJ IDEA刪除類的方法步驟

排行榜

					
					通過Django Admin+HttpRunner1.5.6實現簡易接口測試平臺
IntelliJ IDEA安裝插件的方法步驟
Docker 部署 Prometheus的安裝詳細教程
IntelliJ IDEA設置自動提示功能快捷鍵的方法
idea重置默認配置的方法步驟
php過濾器使用詳解
IntelliJ IDEA調整字體大小的方法
IntelliJ IDEA設置背景圖片的方法步驟
idea打開多個窗口的操作方法
idea給項目打war包的方法步驟
docker /var/lib/docker/aufs/mnt 目錄清理方法
				