API 参考
使用指南-最佳实践
最佳实践章节。
最佳实践
1. 配置管理
- 使用环境变量管理敏感配置
- 不同环境使用不同的配置文件
- 合理使用配置优先级
2. 异常处理
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(BusinessException.class)
public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
return ResponseEntity.badRequest()
.body(ErrorResponse.builder()
.code(e.getErrorCode())
.message(e.getMessage())
.build());
}
}
3. 日志规范
@Slf4j
@Service
public class UserService {
public User createUser(CreateUserRequest request) {
log.info("开始创建用户: email={}", request.getEmail());
try {
User user = userRepository.save(convertToEntity(request));
log.info("用户创建成功: id={}, email={}", user.getId(), user.getEmail());
return user;
} catch (Exception e) {
log.error("用户创建失败: email={}, error={}", request.getEmail(), e.getMessage(), e);
throw e;
}
}
}
4. 缓存策略
@Service
public class UserService {
@Cacheable(value = "users", key = "#id")
public User getUserById(Long id) {
return userRepository.findById(id);
}
@CacheEvict(value = "users", key = "#user.id")
public User updateUser(User user) {
return userRepository.save(user);
}
}