MyBatis-Plus混合使用XML和注解過程
mybatisplus代碼生成器
版本匹配是個比較麻煩的問題,這是我的配置:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version> <!-- 推薦版本 -->
</dependency>CodeGenerator:
package com.neuedu.hisweb.utils;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import com.baomidou.mybatisplus.annotation.FieldFill; // 引入正確的枚舉類
import org.apache.commons.lang3.StringUtils;
import java.util.Collections;
import java.util.Scanner;
public class CodeGenerator {
private static final String URL = "jdbc:mysql://localhost:3306/his02?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=true";
private static final String USERNAME = "root";
private static final String PASSWORD = "1";
private static final String AUTHOR = "xj";
private static final String PARENT_PACKAGE = "com.neuedu.hisweb";
private static final String OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/java";
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
System.out.println("請輸入" + tip + ":");
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("請輸入正確的" + tip + "!");
}
public static void main(String[] args) {
// 獲取需要生成的表名
String tables = scanner("表名,多個英文逗號分割");
FastAutoGenerator.create(URL, USERNAME, PASSWORD)
.globalConfig(builder -> {
builder.author(AUTHOR)
.outputDir(OUTPUT_DIR)
.fileOverride()
.disableOpenDir()
.dateType(DateType.ONLY_DATE)
.commentDate("yyyy-MM-dd");
})
.packageConfig(builder -> {
builder.parent(PARENT_PACKAGE)
.entity("entity")
.service("service")
.serviceImpl("service.impl")
.mapper("mapper")
.controller("controller")
.pathInfo(Collections.singletonMap(
OutputFile.xml,
System.getProperty("user.dir") + "/src/main/resources/mapper"
));
})
.strategyConfig(builder -> {
builder.addInclude(tables.split(","))
.entityBuilder()
.enableLombok()
.naming(NamingStrategy.underline_to_camel)
.columnNaming(NamingStrategy.underline_to_camel)
.logicDeleteColumnName("deleted")
.versionColumnName("version")
.addTableFills(
new Column("create_time", FieldFill.INSERT), // 修改為正確的枚舉值
new Column("update_time", FieldFill.INSERT_UPDATE) // 修改為正確的枚舉值
)
.controllerBuilder()
.enableRestStyle()
.formatFileName("%sController")
.serviceBuilder()
.formatServiceFileName("%sService")
.formatServiceImplFileName("%sServiceImpl")
.mapperBuilder()
.formatMapperFileName("%sMapper")
.formatXmlFileName("%sMapper");
})
.templateEngine(new FreemarkerTemplateEngine())
.execute();
}
}MyBatis-Plus混合使用XML和注解配置
配置原則
1.優(yōu)先級:
- XML 配置會覆蓋注解配置。
2.最佳實踐:
- 簡單的 CRUD 操作可以使用注解(如
@Select、@Insert等)。 - 復(fù)雜的 SQL 查詢(如多表關(guān)聯(lián)、動態(tài) SQL)建議使用 XML 配置。
3.XML 文件位置:
- 默認(rèn)放在
resources/mapper目錄下,文件名與 Mapper 接口名對應(yīng)。
具體配置方法
1.基礎(chǔ)配置
確保 application.yml 或 application.properties 中正確配置 MyBatis-Plus:
# application.yml
mybatis-plus:
# Mapper XML 文件路徑
mapper-locations: classpath:mapper/*.xml
# 實體掃描,多個package用逗號或者分號分隔
type-aliases-package: com.neuedu.hisweb.entity
configuration:
# 開啟駝峰命名
map-underscore-to-camel-case: true2.混合使用示例
Mapper 接口:
package com.neuedu.hisweb.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.neuedu.hisweb.entity.User;
import org.apache.ibatis.annotations.*;
import java.util.List;
public interface UserMapper extends BaseMapper<User> {
// 1. 使用注解實現(xiàn)簡單查詢
@Select("SELECT * FROM user WHERE age > #{age}")
List<User> selectByAge(int age);
// 2. 使用注解實現(xiàn)帶參數(shù)的插入
@Insert("INSERT INTO user(name, age) VALUES(#{name}, #{age})")
@Options(useGeneratedKeys = true, keyProperty = "id")
int insertUser(User user);
// 3. 使用 XML 實現(xiàn)復(fù)雜查詢(XML 文件中定義該方法)
List<User> selectUserWithDepartment();
}對應(yīng)的 XML 文件(resources/mapper/UserMapper.xml):
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.neuedu.hisweb.mapper.UserMapper">
<!-- 實現(xiàn) UserMapper 接口中定義的 selectUserWithDepartment 方法 -->
<select id="selectUserWithDepartment" resultType="com.neuedu.hisweb.entity.User">
SELECT u.*, d.name as dept_name
FROM user u
LEFT JOIN department d ON u.dept_id = d.id
WHERE u.deleted = 0
</select>
<!-- 可以添加更多復(fù)雜 SQL -->
</mapper>注意事項
1.方法名匹配:XML 文件中的 id 必須與 Mapper 接口中的方法名一致。
2.參數(shù)處理:
- 注解方式:使用
@Param注解為參數(shù)命名。 - XML 方式:可以直接使用參數(shù)名或索引。
3.沖突處理:
- 如果同一方法在 XML 和注解中都有定義,XML 配置會覆蓋注解配置。
4.XML 文件路徑:
- 確保
mapper-locations配置正確指向 XML 文件。 - 推薦使用
classpath:mapper/*.xml或classpath*:mapper/**/*.xml。
動態(tài) SQL 示例
對于復(fù)雜的動態(tài) SQL,XML 方式更加靈活:
<select id="selectUserByCondition" resultType="com.neuedu.hisweb.entity.User">
SELECT * FROM user
<where>
<if test="name != null and name != ''">
AND name LIKE CONCAT('%', #{name}, '%')
</if>
<if test="age != null">
AND age >= #{age}
</if>
<if test="deptId != null">
AND dept_id = #{deptId}
</if>
</where>
ORDER BY create_time DESC
</select>常見問題
XML 文件未被加載:
- 檢查
mapper-locations配置是否正確。 - 確保 XML 文件在
resources目錄下的正確位置。
方法找不到:
- 檢查 XML 中的
namespace是否與 Mapper 接口的全限定名一致。 - 檢查方法名(
id)是否匹配。
依賴問題:
- 確保項目中包含 MyBatis-Plus 和 MyBatis 的依賴:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.2</version>
</dependency>@MapperScan與mapper-locations的功能的兼容性
@MapperScan負(fù)責(zé)讓 Spring 容器識別 Mapper 接口。mapper-locations負(fù)責(zé)讓 MyBatis-Plus 加載 XML 中的 SQL 定義。只要兩者的路徑配置與實際文件位置一致,即可同時使用,不會產(chǎn)生沖突。
兩者的核心功能區(qū)別
@MapperScan("com.neuedu.hisweb.mapper") 的作用
- 掃描 Mapper 接口:告訴 Spring 容器去哪里查找 MyBatis-Plus 的 Mapper 接口(如
PatientcostsMapper),并將這些接口注冊為 Spring Bean。 - 必須配置:如果沒有該注解或未通過其他方式掃描 Mapper 接口,Spring 將無法識別這些接口,導(dǎo)致依賴注入失?。ㄈ?nbsp;
@Autowired UserMapper會報錯)。
mapper-locations: classpath:mapper/*.xml 的作用
- 指定 XML 映射文件路徑:告訴 MyBatis-Plus 去哪里查找 XML 格式的 SQL 映射文件(如
PatientcostsMapper.xml)。 - 可選配置:如果 Mapper 接口中所有方法都使用注解(如
@Select)定義 SQL,則無需配置;若存在 XML 定義的 SQL,則必須配置正確路徑。
為什么需要同時使用?
場景示例:
- Mapper 接口
PatientcostsMapper繼承自BaseMapper<Patientcosts>,自動獲得 CRUD 方法(無需 XML)。 - 若該接口中定義了自定義方法(如
selectByCondition),且該方法的 SQL 在PatientcostsMapper.xml中實現(xiàn),則必須通過mapper-locations配置 XML 路徑,否則 MyBatis-Plus 無法找到對應(yīng)的 SQL 語句。
@MapperScan 解決的是 Mapper 接口的注冊問題,mapper-locations 解決的是 XML 映射文件的加載問題,兩者功能獨(dú)立,可同時使用。
目錄結(jié)構(gòu)建議
為避免混淆,建議按以下規(guī)范組織文件:
Mapper 接口位置:
src/main/java/com/neuedu/hisweb/mapper/PatientcostsMapper.java
(與 @MapperScan("com.neuedu.hisweb.mapper") 掃描路徑一致)
XML 映射文件位置:
src/main/resources/mapper/PatientcostsMapper.xml
(與 mapper-locations: classpath:mapper/*.xml 配置路徑一致)
可能的沖突場景與解決方案
1.XML 與注解的 SQL 定義沖突
- 問題:若 Mapper 接口的某個方法同時通過注解(如
@Select)和 XML 定義 SQL,則 XML 配置優(yōu)先級更高,會覆蓋注解中的 SQL。 - 解決方案:同一方法的 SQL 定義只能選擇一種方式(注解或 XML),避免重復(fù)定義。
2.Mapper 接口未被掃描
- 問題:若
@MapperScan掃描路徑錯誤(如寫成@MapperScan("com.neuedu.hisweb.dao")),則 Spring 無法找到PatientcostsMapper,導(dǎo)致啟動時報錯。 - 解決方案:確保
@MapperScan的包路徑與 Mapper 接口實際路徑一致。
驗證配置是否生效
啟動應(yīng)用:
- 若控制臺無
NoSuchBeanDefinitionException或Invalid bound statement錯誤,說明配置正確。
查看日志:
- 若配置了
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl,執(zhí)行 SQL 時會打印 XML 或注解中的 SQL 語句,可驗證是否正確加載。
總結(jié)
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
mybatis if傳入字符串?dāng)?shù)字踩坑記錄及解決
這篇文章主要介紹了mybatis if傳入字符串?dāng)?shù)字踩坑記錄及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-02-02
arthas?jprofiler做復(fù)雜鏈路的調(diào)用分析
這篇文章主要為大家介紹了arthas?jprofiler做復(fù)雜鏈路的調(diào)用分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-06-06
關(guān)于Spring?@Transactional事務(wù)傳播機(jī)制詳解
我們?nèi)粘9ぷ髦袠O少使用事務(wù)傳播級別,單純只是使用事務(wù)和rollbackfor拋出異常來解決事務(wù)問題,但其實我們很多時候使用的是不正確的,或者說會造成事務(wù)粒度過大,本文詳解一下事務(wù)傳播級別,也讓自己更好地處理事務(wù)問題,需要的朋友可以參考下2023-08-08
使用mybatis-plus中Page進(jìn)行分頁不生效解決過程
在使用MyBatis-Plus的Page進(jìn)行分頁時,如果發(fā)現(xiàn)分頁不生效,可能是由于未正確配置分頁插件,確保在配置類中正確引入了分頁插件,并且數(shù)據(jù)庫類型設(shè)置正確,同時,檢查MybatisPlusConfig類是否被正確注入2025-12-12
SpringBoot如何優(yōu)雅的實現(xiàn)重試功能
這篇文章主要詳細(xì)介紹了SpringBoot如何優(yōu)雅的實現(xiàn)重試功能的步驟詳解,文中有詳細(xì)的代碼示例,具有一定的參考價值,感興趣的同學(xué)可以借鑒閱讀2023-06-06
Spring中的@ExceptionHandler注解統(tǒng)一異常處理詳解
這篇文章主要介紹了Spring中的@ExceptionHandler注解統(tǒng)一異常處理詳解,當(dāng)我們使用這個@ExceptionHandler注解時,定義一個異常的處理方法,加上@ExceptionHandler注解,這個方法就會處理類中其他方法拋出的異常,需要的朋友可以參考下2024-01-01
Java8 Optional優(yōu)雅空值判斷的示例代碼
這篇文章主要介紹了Java8 Optional優(yōu)雅空值判斷的相關(guān)知識,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-05-05

