常見問題與解決方案
簡要描述:總結MyBatis-Plus開發過程中常見的問題、錯誤及其解決方案,幫助開發者快速定位和解決問題。
核心概念:
- 常見錯誤:開發中經常遇到的錯誤類型
- 性能問題:性能相關問題的排查和解決
- 配置問題:配置相關的常見問題
- 最佳實踐:推薦的開發實踐和規范
常見錯誤及解決
簡要描述:MyBatis-Plus開發中常見的錯誤類型及其解決方法。
核心概念:
- SQL錯誤:SQL語法和執行錯誤
- 映射錯誤:實體類和數據庫字段映射錯誤
- 配置錯誤:配置文件相關錯誤
- 注解錯誤:注解使用不當導致的錯誤
SQL相關錯誤:
// 1. 字段不存在錯誤
// 錯誤示例:
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("user_name", "張三"); // 數據庫字段是username,不是user_name// 解決方案:
@TableField("username") // 明確指定數據庫字段名
private String userName;// 或者在QueryWrapper中使用正確的字段名
wrapper.eq("username", "張三");// 2. 表名不存在錯誤
// 錯誤示例:
@TableName("sys_user") // 數據庫表名是user,不是sys_user
public class User {// ...
}// 解決方案:
@TableName("user") // 使用正確的表名
public class User {// ...
}// 3. 主鍵策略錯誤
// 錯誤示例:
@TableId(type = IdType.AUTO) // 數據庫主鍵不是自增的
private Long id;// 解決方案:
@TableId(type = IdType.ASSIGN_ID) // 使用雪花算法生成ID
private Long id;// 4. 邏輯刪除字段錯誤
// 錯誤示例:
@TableLogic
private Integer deleted; // 數據庫字段類型是TINYINT,但使用了Integer// 解決方案:
@TableLogic(value = "0", delval = "1")
private Boolean deleted; // 使用Boolean類型
分頁查詢錯誤:
// 1. 分頁插件未配置
// 錯誤現象:分頁查詢返回全部數據
// 解決方案:正確配置分頁插件
@Configuration
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));return interceptor;}
}// 2. 分頁參數錯誤
// 錯誤示例:
Page<User> page = new Page<>(0, 10); // 頁碼從0開始// 解決方案:
Page<User> page = new Page<>(1, 10); // 頁碼從1開始// 3. 分頁查詢count錯誤
// 錯誤示例:
Page<User> page = new Page<>(1, 10);
page.setSearchCount(false); // 禁用count查詢但又需要總數// 解決方案:
Page<User> page = new Page<>(1, 10);
page.setSearchCount(true); // 啟用count查詢
事務相關錯誤:
// 1. 事務不生效
// 錯誤示例:
@Service
public class UserService {@Transactionalprivate void updateUser(User user) { // private方法,事務不生效// ...}
}// 解決方案:
@Service
public class UserService {@Transactionalpublic void updateUser(User user) { // public方法// ...}
}// 2. 異常被捕獲導致事務不回滾
// 錯誤示例:
@Transactional
public void updateUser(User user) {try {userMapper.updateById(user);int i = 1 / 0; // 拋出異常} catch (Exception e) {log.error("更新用戶失敗", e); // 異常被捕獲,事務不回滾}
}// 解決方案:
@Transactional(rollbackFor = Exception.class)
public void updateUser(User user) {try {userMapper.updateById(user);int i = 1 / 0;} catch (Exception e) {log.error("更新用戶失敗", e);throw e; // 重新拋出異常,觸發事務回滾}
}
性能問題排查
簡要描述:識別和解決MyBatis-Plus應用中的性能問題。
核心概念:
- 慢查詢識別:識別執行緩慢的SQL
- 內存泄漏:排查內存泄漏問題
- 連接池問題:數據庫連接池相關問題
- 緩存問題:緩存使用不當導致的性能問題
慢查詢排查:
// 1. 開啟SQL日志
// application.yml
logging:level:com.example.mapper: debugorg.springframework.jdbc: debug// 2. 使用性能分析插件
@Configuration
public class PerformanceConfig {@Bean@Profile("dev")public PerformanceInterceptor performanceInterceptor() {PerformanceInterceptor interceptor = new PerformanceInterceptor();interceptor.setMaxTime(1000); // 超過1秒的SQL會被記錄interceptor.setFormat(true);return interceptor;}
}// 3. 自定義慢查詢監控
@Component
public class SlowQueryMonitor {private static final Logger logger = LoggerFactory.getLogger(SlowQueryMonitor.class);@EventListenerpublic void handleSlowQuery(SlowQueryEvent event) {if (event.getExecutionTime() > 1000) {logger.warn("慢查詢檢測: SQL={}, 執行時間={}ms, 參數={}", event.getSql(), event.getExecutionTime(), event.getParameters());// 可以發送告警通知sendSlowQueryAlert(event);}}private void sendSlowQueryAlert(SlowQueryEvent event) {// 發送告警邏輯}
}
內存泄漏排查:
// 1. SqlSession未關閉導致內存泄漏
// 錯誤示例:
public List<User> findUsers() {SqlSession sqlSession = sqlSessionFactory.openSession();List<User> users = sqlSession.selectList("findUsers");// 未關閉SqlSession,導致內存泄漏return users;
}// 解決方案:
public List<User> findUsers() {try (SqlSession sqlSession = sqlSessionFactory.openSession()) {return sqlSession.selectList("findUsers");} // 自動關閉SqlSession
}// 2. 大結果集查詢導致內存溢出
// 錯誤示例:
public List<User> findAllUsers() {return userMapper.selectList(null); // 查詢所有數據,可能導致內存溢出
}// 解決方案:使用分頁查詢
public List<User> findAllUsers() {List<User> allUsers = new ArrayList<>();int pageSize = 1000;int current = 1;while (true) {Page<User> page = new Page<>(current, pageSize);IPage<User> result = userMapper.selectPage(page, null);allUsers.addAll(result.getRecords());if (result.getRecords().size() < pageSize) {break;}current++;}return allUsers;
}
版本升級注意事項
簡要描述:MyBatis-Plus版本升級過程中需要注意的重要事項和兼容性問題。
核心概念:
- 版本兼容性:不同版本間的兼容性問題
- API變更:API接口的變更和廢棄
- 配置變更:配置方式的變化
- 依賴升級:相關依賴的升級要求
3.x升級到4.x注意事項:
# 1. 依賴變更
# 舊版本(3.x)
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.3</version>
</dependency># 新版本(4.x)
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>4.0.0</version>
</dependency># 2. 配置變更
# 舊配置方式
mybatis-plus:global-config:db-config:id-type: autologic-delete-value: 1logic-not-delete-value: 0# 新配置方式
mybatis-plus:global-config:db-config:id-type: autologic-delete-field: deletedlogic-delete-value: 1logic-not-delete-value: 0
API變更處理:
// 1. 分頁插件配置變更
// 舊版本配置
@Configuration
public class MybatisPlusConfig {@Beanpublic PaginationInterceptor paginationInterceptor() {PaginationInterceptor paginationInterceptor = new PaginationInterceptor();paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));return paginationInterceptor;}
}// 新版本配置
@Configuration
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));return interceptor;}
}// 2. 性能分析插件變更
// 舊版本
@Bean
public PerformanceInterceptor performanceInterceptor() {return new PerformanceInterceptor();
}// 新版本(已廢棄,建議使用第三方工具)
// 使用p6spy或其他性能監控工具
升級檢查清單:
// 升級前檢查清單
public class UpgradeChecklist {/*** 1. 檢查依賴兼容性* - Spring Boot版本兼容性* - JDK版本要求* - 其他依賴庫版本*//*** 2. 檢查配置文件* - application.yml配置項變更* - 插件配置方式變更* - 全局配置項變更*//*** 3. 檢查代碼兼容性* - 廢棄API的替換* - 新增注解的使用* - 方法簽名變更*//*** 4. 測試驗證* - 單元測試通過* - 集成測試通過* - 性能測試對比*/
}
最佳實踐總結
簡要描述:MyBatis-Plus開發的最佳實踐和推薦規范總結。
核心概念:
- 代碼規范:代碼編寫規范
- 性能優化:性能優化建議
- 安全實踐:安全相關的最佳實踐
- 維護性:提高代碼可維護性的建議
開發規范總結:
// 1. 實體類設計規范
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("sys_user")
public class User implements Serializable {private static final long serialVersionUID = 1L;@TableId(value = "id", type = IdType.ASSIGN_ID)private Long id;@TableField("username")@NotBlank(message = "用戶名不能為空")private String username;@TableField(value = "create_time", fill = FieldFill.INSERT)private LocalDateTime createTime;@TableLogic(value = "0", delval = "1")private Boolean deleted;@Versionprivate Integer version;
}// 2. Mapper接口規范
@Mapper
public interface UserMapper extends BaseMapper<User> {/*** 自定義查詢方法要有明確的注釋*/List<User> selectByCustomCondition(@Param("condition") UserQueryCondition condition);
}// 3. Service層規范
@Service
@Transactional(rollbackFor = Exception.class)
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {@Overridepublic IPage<User> findUserPage(UserPageRequest request) {// 參數校驗validatePageRequest(request);// 構建查詢條件LambdaQueryWrapper<User> wrapper = buildQueryWrapper(request);// 執行分頁查詢Page<User> page = new Page<>(request.getCurrent(), request.getSize());return baseMapper.selectPage(page, wrapper);}private void validatePageRequest(UserPageRequest request) {if (request.getCurrent() < 1) {throw new IllegalArgumentException("頁碼不能小于1");}if (request.getSize() > 100) {throw new IllegalArgumentException("每頁大小不能超過100");}}
}
性能優化總結:
// 1. 查詢優化
public class QueryOptimization {// 使用字段選擇,避免查詢不必要的字段public List<UserSimpleVO> findUserSimpleList() {LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();wrapper.select(User::getId, User::getUsername, User::getEmail);return baseMapper.selectList(wrapper);}// 使用批量操作public boolean batchUpdateStatus(List<Long> userIds, Integer status) {if (CollectionUtils.isEmpty(userIds)) {return true;}List<User> users = userIds.stream().map(id -> {User user = new User();user.setId(id);user.setStatus(status);return user;}).collect(Collectors.toList());return updateBatchById(users);}// 使用緩存@Cacheable(value = "users", key = "#id")public User findById(Long id) {return baseMapper.selectById(id);}
}// 2. 連接池優化
spring:datasource:hikari:maximum-pool-size: 20minimum-idle: 5connection-timeout: 30000idle-timeout: 600000max-lifetime: 1800000
安全實踐總結:
// 1. 防止SQL注入
public class SecurityPractice {// 正確:使用參數化查詢public List<User> findUsersByName(String username) {LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();wrapper.eq(User::getUsername, username);return baseMapper.selectList(wrapper);}// 錯誤:直接拼接SQLpublic List<User> findUsersByNameBad(String username) {QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.apply("username = '" + username + "'"); // 危險!return baseMapper.selectList(wrapper);}// 2. 敏感信息處理public UserVO getUserInfo(Long userId) {User user = baseMapper.selectById(userId);if (user == null) {return null;}UserVO userVO = new UserVO();BeanUtils.copyProperties(user, userVO);userVO.setPassword(null); // 不返回密碼return userVO;}
}