目錄
1.簡介
2.自定義SQL具體實現
2.1.注解SQL
2.2.Wrapper傳參+注解SQL
2.3.Wrapper傳參+xml文件SQL
2.4.正常傳參+XML文件SQL
3.總結
1.簡介
????????Mybatis-Plus(以下簡稱MBP)的初衷是為了簡化開發(fā),而不建議開發(fā)者自己寫SQL語句的;但是有時客戶需求比較復雜,僅使用MBP提供的Service,Mapper與Wrapper進行組合,難以實現可以需求; 這時我們就要用到自定義的SQL了。
????????Java 開發(fā)使用 mybatis-plus 來執(zhí)行 sql 操作,往往比 mybatis 能夠省時省力,因為 mybatis-plus 封裝了很多常用的接口。但對于一些更為復雜的查詢來說,mybatis-plus 也相形見絀,還得需要我們自定義 sql 語句。本文就來介紹一下在使用?mybatis-plus/mybatis 的情況下,如何自定義 sql 語句、動態(tài) sql 等。
Mybatis-Plus實現自定義的方式有以下幾種:
1)注解SQL
2)Wrapper傳參+注解SQL
????????局限性:不適用于多表關聯查詢,查詢字段過多代碼比較凌亂
3)Wrapper傳參+XML文件SQL:推薦
4)對象傳參+XML文件SQL
????????最傳統(tǒng)的寫法,流程過于繁瑣,簡單的單表查詢時,配置麻煩
2.自定義SQL具體實現
2.1.注解SQL
Mybatis-plus提供了注解SQL功能,可以通過注解方式實現SQL的編寫,注解SQL的前提是在Mybatis的配置文件中開啟注解功能。
我們可以在Mapper的繼承類中,使用完整的自定義SQL;
//多數據源情況下,@DS注解用于指定數據源
@DS("zw-mysqldb")
public interface CarMapper extends BaseMapper<Car> {
@Select("select * from car where car_seq = #{carSeq}")
Car queryCar(String carSeq);
}
@RequestMapping("/ok")
public void testCustomSQL2() {
Car car = carMapper.queryCar("11");
System.out.println(car.toString());
}
補充:?
1)使用@Param注解
當以下面的方式進行寫SQL語句時:
@Select("select column from table where userid = #{userid} ")
public int selectColumn(int userid);
當你使用了使用@Param注解來聲明參數時,如果使用 #{} 或 ${} 的方式都可以。
@Select("select column from table where userid = ${userid} ")
public int selectColumn(@Param("userid") int userid);
當你不使用@Param注解來聲明參數時,必須使用使用 #{}方式。如果使用 ${} 的方式,會報錯。
@Select("select column from table where userid = ${userid} ")
public int selectColumn(@Param("userid") int userid);
2)不使用@Param注解
不使用@Param注解時,參數只能有一個,并且是Javabean。在SQL語句里可以引用JavaBean的屬性,而且只能引用JavaBean的屬性。
// 這里id是user的屬性
@Select("SELECT * from Table where id = ${id}")
Enchashment selectUserById(User user);
上面的代碼中使用了注解SQL的方式,通過@Select注解指定了SQL語句。在方法中使用@Param注解指定參數名稱,可以方便的進行參數傳遞,參數名稱與sql參數名稱一致可省略。
注解SQL的優(yōu)點是代碼簡潔,可讀性好,同時也可以結合Wrapper等方式進行復雜的SQL構建。
2.2.Wrapper傳參+注解SQL
使用Wrapper方式的一些使用場景:
1)動態(tài)查詢:使用Wrapper可以根據不同的查詢條件,動態(tài)地拼接SQL語句,實現精確查詢。
2)多表聯合查詢:在多表聯合查詢時,使用Wrapper可以方便地拼接SQL語句,實現多表聯合查詢。
3)分頁查詢:在分頁查詢時,使用Wrapper可以方便地拼接SQL語句,實現分頁功能。
4)條件查詢:使用Wrapper可以根據不同的條件,動態(tài)地拼接SQL語句,實現條件查詢。
5)排序查詢:使用Wrapper可以方便地拼接SQL語句,實現排序功能
使用SQL結合Wrapper進行復雜的SQL構建時,通常需要完成以下幾個步驟:
a)創(chuàng)建Wrapper對象
通過創(chuàng)建Wrapper對象,可以方便地進行SQL構建和條件設置。下面是創(chuàng)建Wrapper對象的示例代碼:
QueryWrapper<Entity> wrapper = new QueryWrapper<>();
b)設置查詢條件
可以使用Wrapper對象的方法設置查詢條件,例如eq、ne等方法可以設置等于、不等于等條件。下面是設置查詢條件的示例代碼:
wrapper.eq("column1", value1)
.ne("column2", value2)
.like("column3", value3);
//示例
wrapper.eq("car_state", "1")
.like("car_id", "渝A");
c)設置排序條件(非必須)
可以使用Wrapper對象的orderBy方法設置排序條件,例如orderByAsc、orderByDesc等方法可以設置升序、降序等條件。下面是設置排序條件的示例代碼:
wrapper.orderByAsc("car_id")
d)設置分頁條件(非必須)
可以使用Wrapper對象的方法設置分頁條件,例如page方法可以設置頁碼和每頁大小等條件。下面是設置分頁條件的示例代碼:
Page<Car> resultPage = new Page<>(1, 10);
carMapper.selectByPrimaryKey(resultPage,wrapper)
e)mapper接口
@Select("select * from car ${ew.customSqlSegment}")
Page<Car> selectByPrimaryKey(Page<Car> page, @Param(Constants.WRAPPER) QueryWrapper<Car> queryWrapper);
f)執(zhí)行SQL操作
接口的方法執(zhí)行SQL操作,例如selectList、selectPage等方法可以執(zhí)行SQL查詢操作,也可以自定義查詢。下面是執(zhí)行SQL操作的示例完整代碼:
//分頁查詢方式1
QueryWrapper<Car> wrapper = new QueryWrapper<>();
Page<Car> resultPage = new Page<>(1, 10);
wrapper.eq("car_state", "1")
.like("car_id", "渝A")
.orderByAsc("car_id");//排序
carMapper.selectByPrimaryKey(resultPage,wrapper);
//分頁查詢方式2
IPage<Car> page = new Page<>(1, 10); // 分頁查詢
LambdaQueryWrapper<Car> qw = new LambdaQueryWrapper<Car>()
.like(Car::getCarId, "渝A") // 車牌號 =
.eq(Car::getCarState, 1); // 狀態(tài)
//selectPage是BaseMapper自帶方法
IPage<Car> userPage = carMapper.selectPage(page, qw);
注意:
1)QueryWrapper中使用自定義uservo類,不能使用LambdaQueryWrapper?
2)上邊涉及到 IPage 和 Page 都可以用用于分頁,這里就涉及到MybatisPlus的幾種方式問題
xml文件
g)執(zhí)行結果:
補充:
在實際應用中,我們還可以使用LambdaQueryWrapper和QueryWrapper實現更多復雜的查詢操作,以滿足不同的業(yè)務需求。例如,我們可以使用LambdaQueryWrapper和QueryWrapper進行動態(tài)查詢,通過判斷前端傳入的參數,來組合SQL語句,實現靈活的查詢操作?
public List<UserEntity> getUserList(String name, Integer age) {
LambdaQueryWrapper<UserEntity> qw = new LambdaQueryWrapper<UserEntity>()
.eq(StringUtils.isNotEmpty(name), UserEntity::getName, name) // 姓名 = name
.gt(age != null, UserEntity::getAge, age); // 年齡 > age
return userMapper.selectList(qw);
}
以上代碼中,我們通過LambdaQueryWrapper實現了動態(tài)的查詢操作。如果傳入的name參數不為空,那么就會添加一個等于查詢條件;如果傳入的age參數不為空,那么就會添加一個大于查詢條件。
這樣的查詢操作,可以根據前端傳入的參數,靈活地組合SQL語句,實現更多的業(yè)務需求。
注意:
????????1)mapper方法里的@Param(Constants.WRAPPER) Wrapper query對象,Constants.WRAPPER的值就是ew。
????????2)首先判斷ew.emptyOfWhere是否存在where條件,有的話再拼接上去,????????3)ew.customSqlSegment該值是WHERE + sql語句,還有個ew.sqlSegment是不包括WHERE字符串
????????4)${ew.customSqlSegment}是一個查詢條件占位符,代表Wapper查詢條件。?
當然,Mybatis-Plus提供了一些自定義SQL方法,例如selectObjs、selectByMap等,可以直接使用,例如:
List<Object> objs = userMapper.selectObjs(
new QueryWrapper<User>().select("max(age)").eq("name", "張三")
);
2.3.Wrapper傳參+xml文件SQL
Wrapper傳參是Mybatis中的一種高級操作方式,可以在查詢時動態(tài)傳遞參數
1)mapper類
Car selectBySeq (@Param(Constants.WRAPPER) QueryWrapper<Car> queryWrapper);
2)xml配置文件?
<select id="selectBySeq " resultMap="BaseResultMap">
select * from `car` ${ew.customSqlSegment}
</select>
3)通過Wapper傳遞查詢參數
使用Wrapper動態(tài)傳遞參數
1.使用Wrapper基類,自定義Where后面的SQL語句;
2.使用QueryWrapper
-
select | select(String... sqlSelect)
例select("id", "name", "age")
上面兩種方式任意選擇一種,參數都是Wrapper
@RequestMapping("/ok")
public void testCustomSQL2() {
LambdaQueryWrapper<Car> query = new LambdaQueryWrapper<>();
query.eq(Car::getCarId, "11");
Car car= carMapper.queryCarSeq(query);
System.out.println(car.toString());
}
//或者
Wrapper wrapper = new QueryWrapper<Car>().eq("car_state", 1).like("cai_id", "渝");
List<Car> userList = carMapper.queryCarSeq(wrapper);
XML文件SQL和Wrapper傳參結合的優(yōu)點在于提高了代碼的可維護性、可讀性和安全性,適用于代碼量大,需要多人協作開發(fā)的場景,并且能夠防止SQL注入攻擊?
2.4.正常傳參+XML文件SQL
在resources目錄下創(chuàng)建一個mapper文件夾,然后創(chuàng)建一個與Mapper接口同名的xml文件,例如UserMapper.xml,定義自定義SQL語句
//xml文件式,myabtis原生方式
Car selectByAnnotationXML(String seq);
在mapper下創(chuàng)建文件UserDao.xml?
<select id="selectByAnnotationXML" parameterType="java.lang.String" resultMap="BaseResultMap">
select *
from car
where car_seq = #{seq,jdbcType=VARCHAR}
</select>
這種方式是在接觸mybatis時候,最基礎的方式?
3.總結
????????總的來說,sql的寫法有兩種,一種是直接使用注解寫在mapper方法上,一種是寫在xml文件中;傳參的方式也有兩種,一種是通過方法傳參直接在xml文件中組裝sql,一種是通過Wapper傳遞參數條件構造器
注解的優(yōu)點
????????簡潔易懂:相比于XML配置,注解的使用更加簡潔直觀,使代碼更具可讀性和可維護性。
????????易于調試:注解配置可以直接在Java類中編寫,減少了在XML中查找和修改SQL的時間。
????????更好的性能:在執(zhí)行大量的增刪改操作時,注解配置的性能更高,因為沒有XML解析的開銷。
注解的缺點
????????不利于維護:將SQL和Java代碼耦合在一起,使得代碼難以維護和重構,特別是在涉及到較復雜SQL的情況下。
????????SQL可讀性差:相比于在XML中編寫SQL,注解中的SQL語句通常會更加冗長和難以讀懂。
XML的優(yōu)點
????????易于維護:將SQL分離出Java代碼,代碼的維護性更高,特別是在需要修改SQL時。
????????SQL可讀性好:在XML中編寫SQL,可以使得SQL的格式更加清晰,可讀性更強。
????????易于管理:XML配置文件可以全局管理,使得項目的結構更加清晰明了。
XML的缺點
????????繁瑣:XML配置相對于注解,配置較為繁瑣,需要更多的代碼量。
????????性能問題:在執(zhí)行大量操作時,XML的解析和讀取會占用一定的時間,降低了系統(tǒng)的性能。
總之,注解和XML的選擇應根據項目的實際情況和需求進行決定。對于簡單的查詢和操作,注解可能更加適合;而對于復雜的查詢和操作,XML則更加適合。文章來源:http://www.zghlxwxcb.cn/news/detail-541123.html
常用方法參考官方文檔文章來源地址http://www.zghlxwxcb.cn/news/detail-541123.html
到了這里,關于Mybatis-Plus:實現自定義SQL的文章就介紹完了。如果您還想了解更多內容,請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章,希望大家以后多多支持TOY模板網!