SpringBoot + MyBatis 实战：从零搭建一个用户管理系统（附完整代码）

SpringBoot MyBatis 实战从零搭建企业级用户管理系统在当今快速发展的互联网时代用户管理系统作为各类应用的基础组件其开发效率和稳定性直接影响着整个项目的成败。SpringBoot以其约定优于配置的理念配合MyBatis强大的SQL定制能力已成为Java开发者构建用户管理系统的首选技术栈。本文将带你从零开始打造一个功能完善、架构清晰的用户管理系统涵盖从项目搭建到前后端联调的完整流程。1. 项目初始化与环境配置1.1 创建SpringBoot项目骨架现代Java项目开发通常从Spring Initializr开始。以下是使用IDEA创建项目的步骤打开IDEA选择New Project → Spring Initializr配置项目基本信息Group: com.exampleArtifact: user-managementType: MavenJava版本: 11添加必要依赖Spring WebMyBatis FrameworkMySQL DriverLombok!-- pom.xml关键依赖 -- dependencies dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency dependency groupIdorg.mybatis.spring.boot/groupId artifactIdmybatis-spring-boot-starter/artifactId version2.2.0/version /dependency dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId scoperuntime/scope /dependency dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId optionaltrue/optional /dependency /dependencies1.2 数据库配置与连接池优化在application.yml中配置数据库连接和MyBatis参数spring: datasource: url: jdbc:mysql://localhost:3306/user_db?useSSLfalseserverTimezoneUTCcharacterEncodingUTF-8 username: root password: yourpassword hikari: maximum-pool-size: 10 minimum-idle: 5 connection-timeout: 30000 mybatis: mapper-locations: classpath:mapper/*.xml configuration: map-underscore-to-camel-case: true提示生产环境建议使用连接池如HikariCP并合理配置连接数参数2. 领域模型设计与数据持久层2.1 用户实体与DTO设计采用Lombok简化实体类代码同时设计数据传输对象Data Builder NoArgsConstructor AllArgsConstructor public class User { private Long id; private String username; private String password; private String email; private String phone; private Integer status; private LocalDateTime createTime; private LocalDateTime updateTime; } Data public class UserDTO { private String username; private String email; private String phone; }2.2 MyBatis Mapper接口与XML配置创建用户Mapper接口并实现基础CRUD操作Mapper public interface UserMapper { Insert(INSERT INTO user(username, password, email, phone) VALUES(#{username}, #{password}, #{email}, #{phone})) Options(useGeneratedKeys true, keyProperty id) int insert(User user); Select(SELECT * FROM user WHERE id #{id}) User selectById(Long id); Update(UPDATE user SET username#{username}, email#{email}, phone#{phone} WHERE id#{id}) int update(User user); Delete(DELETE FROM user WHERE id #{id}) int delete(Long id); }对于复杂查询推荐使用XML配置方式!-- src/main/resources/mapper/UserMapper.xml -- mapper namespacecom.example.usermanagement.mapper.UserMapper select idselectByCondition resultTypeUser SELECT * FROM user where if testusername ! null AND username LIKE CONCAT(%, #{username}, %) /if if teststatus ! null AND status #{status} /if /where ORDER BY create_time DESC /select /mapper3. 业务逻辑层实现3.1 用户服务核心逻辑服务层应包含业务验证和逻辑处理Service RequiredArgsConstructor public class UserService { private final UserMapper userMapper; private final PasswordEncoder passwordEncoder; public User createUser(UserDTO userDTO) { if (userMapper.existsByUsername(userDTO.getUsername())) { throw new BusinessException(用户名已存在); } User user User.builder() .username(userDTO.getUsername()) .password(passwordEncoder.encode(default123)) .email(userDTO.getEmail()) .phone(userDTO.getPhone()) .status(1) .createTime(LocalDateTime.now()) .build(); userMapper.insert(user); return user; } public PageInfoUser queryUsers(UserQuery query, Pageable pageable) { PageHelper.startPage(pageable.getPageNumber(), pageable.getPageSize()); ListUser users userMapper.selectByCondition(query); return new PageInfo(users); } }3.2 异常处理与事务管理使用Spring的声明式事务保证数据一致性Transactional(rollbackFor Exception.class) public void updateUserStatus(Long userId, Integer status) { User user userMapper.selectById(userId); if (user null) { throw new NotFoundException(用户不存在); } user.setStatus(status); user.setUpdateTime(LocalDateTime.now()); userMapper.update(user); }全局异常处理配置RestControllerAdvice public class GlobalExceptionHandler { ExceptionHandler(BusinessException.class) public ResponseEntityErrorResponse handleBusinessException(BusinessException ex) { return ResponseEntity.badRequest() .body(new ErrorResponse(ex.getMessage())); } ExceptionHandler(Exception.class) public ResponseEntityErrorResponse handleException(Exception ex) { return ResponseEntity.internalServerError() .body(new ErrorResponse(系统繁忙请稍后再试)); } }4. RESTful API设计与实现4.1 用户控制器设计遵循RESTful规范设计API接口RestController RequestMapping(/api/users) RequiredArgsConstructor public class UserController { private final UserService userService; PostMapping public ResponseEntityUser createUser(Valid RequestBody UserDTO userDTO) { User user userService.createUser(userDTO); return ResponseEntity.created(URI.create(/users/ user.getId())) .body(user); } GetMapping(/{id}) public ResponseEntityUser getUser(PathVariable Long id) { return ResponseEntity.ok(userService.getUserById(id)); } GetMapping public ResponseEntityPageInfoUser listUsers( RequestParam(required false) String username, RequestParam(required false) Integer status, RequestParam(defaultValue 0) int page, RequestParam(defaultValue 10) int size) { UserQuery query new UserQuery(username, status); Pageable pageable PageRequest.of(page, size); return ResponseEntity.ok(userService.queryUsers(query, pageable)); } }4.2 API文档与测试使用Swagger生成API文档Configuration EnableSwagger2 public class SwaggerConfig { Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage(com.example.usermanagement.controller)) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title(用户管理系统API) .description(用户管理相关接口文档) .version(1.0) .build(); } }API测试示例使用Postman创建用户Method: POSTURL: http://localhost:8080/api/usersBody:{ username: testuser, email: testexample.com, phone: [phone] }查询用户列表Method: GETURL: http://localhost:8080/api/users?page0size105. 系统安全与性能优化5.1 Spring Security集成配置基本的安全认证Configuration EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { Override protected void configure(HttpSecurity http) throws Exception { http .csrf().disable() .authorizeRequests() .antMatchers(/api/users/**).authenticated() .anyRequest().permitAll() .and() .httpBasic(); } Bean public PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } }5.2 缓存与性能优化使用Redis缓存用户数据Service RequiredArgsConstructor public class UserServiceImpl implements UserService { private final UserMapper userMapper; private final RedisTemplateString, User redisTemplate; Override Cacheable(value user, key #id) public User getUserById(Long id) { return userMapper.selectById(id); } Override CacheEvict(value user, key #user.id) public void updateUser(User user) { userMapper.update(user); } }配置Redis缓存spring: cache: type: redis redis: host: localhost port: 63796. 测试与部署6.1 单元测试与集成测试编写服务层单元测试ExtendWith(MockitoExtension.class) class UserServiceTest { Mock private UserMapper userMapper; InjectMocks private UserService userService; Test void shouldCreateUserSuccessfully() { UserDTO dto new UserDTO(testuser, testexample.com, 13800138000); when(userMapper.existsByUsername(anyString())).thenReturn(false); when(userMapper.insert(any(User.class))).thenReturn(1); User user userService.createUser(dto); assertNotNull(user); assertEquals(testuser, user.getUsername()); } }6.2 项目打包与部署使用Maven打包可执行JARmvn clean packageDocker部署配置FROM openjdk:11-jre-slim COPY target/user-management-*.jar app.jar EXPOSE 8080 ENTRYPOINT [java, -jar, app.jar]构建并运行Docker容器docker build -t user-management . docker run -p 8080:8080 -d user-management7. 项目扩展与最佳实践7.1 日志与监控配置Logback日志!-- src/main/resources/logback-spring.xml -- configuration appender nameFILE classch.qos.logback.core.rolling.RollingFileAppender filelogs/user-management.log/file rollingPolicy classch.qos.logback.core.rolling.TimeBasedRollingPolicy fileNamePatternlogs/user-management.%d{yyyy-MM-dd}.log/fileNamePattern maxHistory30/maxHistory /rollingPolicy encoder pattern%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n/pattern /encoder /appender root levelINFO appender-ref refFILE / /root /configuration集成Spring Boot Actuator监控management: endpoints: web: exposure: include: health,info,metrics endpoint: health: show-details: always7.2 前后端分离实践配置CORS支持Configuration public class WebConfig implements WebMvcConfigurer { Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping(/api/**) .allowedOrigins(http://localhost:3000) .allowedMethods(GET, POST, PUT, DELETE) .allowCredentials(true); } }统一API响应格式public class ApiResponseT { private int code; private String message; private T data; public static T ApiResponseT success(T data) { return new ApiResponse(0, success, data); } // 其他工厂方法... } RestControllerAdvice public class ResponseAdvice implements ResponseBodyAdviceObject { Override public boolean supports(MethodParameter returnType, Class converterType) { return true; } Override public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) { if (body instanceof ApiResponse) { return body; } return ApiResponse.success(body); } }8. 常见问题与解决方案8.1 MyBatis常见问题排查问题1SQL注入风险解决方案始终使用参数化查询避免直接拼接SQL语句使用MyBatis的#{}语法而非${}// 错误示例 - 存在SQL注入风险 Select(SELECT * FROM user WHERE username ${username}) User findByUsername(Param(username) String username); // 正确示例 - 使用参数化查询 Select(SELECT * FROM user WHERE username #{username}) User findByUsername(Param(username) String username);问题2N1查询问题解决方案使用One和Many注解配置关联查询或者使用XML配置中的collection和associationSelect(SELECT * FROM user) Results({ Result(property id, column id), Result(property roles, column id, many Many(select findRolesByUserId)) }) ListUser findAllWithRoles(); Select(SELECT r.* FROM user_role ur JOIN role r ON ur.role_id r.id WHERE ur.user_id #{userId}) ListRole findRolesByUserId(Long userId);8.2 性能优化技巧数据库优化为常用查询字段添加索引避免SELECT *只查询需要的字段合理使用分页查询应用层优化启用二级缓存批量操作代替循环单条操作异步处理非关键路径操作// 批量插入示例 Insert(script INSERT INTO user(username, password) VALUES foreach collectionusers itemuser separator, (#{user.username}, #{user.password}) /foreach /script) int batchInsert(Param(users) ListUser users);9. 项目结构优化建议9.1 模块化拆分对于大型项目建议按功能模块拆分user-management/ ├── user-core/ # 核心模块 ├── user-api/ # API接口模块 ├── user-service/ # 业务逻辑模块 └── user-dao/ # 数据访问模块9.2 代码规范与质量推荐实践使用Checkstyle统一代码风格配置SonarQube进行代码质量检测编写全面的单元测试使用Git进行版本控制!-- checkstyle配置示例 -- plugin groupIdorg.apache.maven.plugins/groupId artifactIdmaven-checkstyle-plugin/artifactId version3.1.2/version configuration configLocationgoogle_checks.xml/configLocation /configuration /plugin10. 进阶功能扩展10.1 多数据源配置对于需要访问多个数据库的场景Configuration MapperScan(basePackages com.example.usermanagement.mapper.primary, sqlSessionFactoryRef primarySqlSessionFactory) public class PrimaryDataSourceConfig { Bean ConfigurationProperties(spring.datasource.primary) public DataSource primaryDataSource() { return DataSourceBuilder.create().build(); } Bean public SqlSessionFactory primarySqlSessionFactory( Qualifier(primaryDataSource) DataSource dataSource) throws Exception { SqlSessionFactoryBean factoryBean new SqlSessionFactoryBean(); factoryBean.setDataSource(dataSource); return factoryBean.getObject(); } }10.2 分布式事务处理使用Seata处理分布式事务GlobalTransactional public void distributedOperation() { // 调用多个服务的操作 userService.update(user); orderService.create(order); }配置Seataspring: cloud: alibaba: seata: tx-service-group: my_test_tx_group11. 实战经验分享在实际项目开发中有几个关键点值得特别注意密码安全永远不要明文存储用户密码使用BCrypt等强哈希算法接口幂等性对于创建、更新操作考虑实现幂等接口数据校验前后端都需要进行数据校验推荐使用Hibernate ValidatorAPI版本控制从项目开始就考虑API版本管理策略// 密码加密示例 Bean public PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } // 在服务层使用 public User createUser(UserDTO userDTO) { User user new User(); user.setPassword(passwordEncoder.encode(userDTO.getPassword())); // 其他字段设置... return userRepository.save(user); }12. 开发工具推荐提高开发效率的工具链工具类别推荐选择主要用途IDEIntelliJ IDEA UltimateJava开发数据库工具DBeaver / DataGrip数据库管理API测试Postman / InsomniaAPI调试版本控制Git GitLens代码版本管理持续集成Jenkins / GitHub Actions自动化构建部署文档生成Swagger UI / Spring REST DocsAPI文档生成13. 学习资源推荐想要深入掌握SpringBoot和MyBatis可以参考以下资源官方文档Spring Boot Reference GuideMyBatis-Spring-Boot-Starter书籍《Spring Boot实战》《MyBatis从入门到精通》在线课程Spring官方培训课程慕课网、极客时间相关专题14. 项目演进路线随着业务发展用户管理系统可以逐步演进初期基础CRUD功能简单权限控制中期增加OAuth2.0认证引入消息队列处理异步任务实现分布式会话管理后期微服务化拆分多租户支持大数据分析用户行为// 未来可能添加的OAuth2配置 Configuration EnableAuthorizationServer public class AuthServerConfig extends AuthorizationServerConfigurerAdapter { Override public void configure(ClientDetailsServiceConfigurer clients) throws Exception { clients.inMemory() .withClient(clientapp) .secret(passwordEncoder.encode(123456)) .authorizedGrantTypes(password, refresh_token) .scopes(read, write) .accessTokenValiditySeconds(3600); } }15. 团队协作建议多人协作开发用户管理系统时建议代码规范统一代码风格使用自动化工具检查API设计先定义API契约再并行开发分支策略采用Git Flow工作流代码审查强制PR审查保证代码质量文档文化代码即文档保持文档与代码同步!-- API设计示例 -- # 用户登录接口 ## 请求 POST /api/auth/login json { username: string, password: string }响应200 OK{ token: string, expiresIn: 3600 }## 16. 生产环境注意事项 将系统部署到生产环境时需要特别注意 1. **安全配置** - 禁用Swagger等开发工具 - 配置HTTPS - 敏感信息加密 2. **性能调优** - JVM参数优化 - 数据库连接池配置 - 缓存策略优化 3. **监控告警** - 应用健康监控 - 业务指标监控 - 日志集中管理 yaml # 生产环境配置示例 spring: profiles: prod datasource: hikari: maximum-pool-size: 20 minimum-idle: 10 redis: timeout: 300017. 技术债务管理在快速迭代过程中需要注意控制技术债务识别债务定期进行代码审查识别潜在问题评估影响评估债务对系统的影响程度制定计划安排专门时间偿还高优先级债务预防新增通过代码规范、自动化测试减少新债务// 技术债务标记示例 // TODO: 2023-12-01 - 需要优化这个查询目前是N1问题 Deprecated public ListUser findAllUsersWithRoles() { // 当前实现有性能问题 }18. 用户管理系统扩展功能基础功能完善后可以考虑添加权限管理RBAC模型实现细粒度权限控制操作审计记录关键操作日志数据导出支持Excel/PDF格式导出消息通知集成邮件/短信通知功能多因素认证增加安全性// 操作审计示例 Aspect Component public class AuditLogAspect { AfterReturning(pointcut annotation(auditable), returning result) public void auditLog(JoinPoint jp, Auditable auditable, Object result) { String operation auditable.value(); // 记录操作日志... } } Auditable(用户创建) public User createUser(UserDTO dto) { // 业务逻辑... }19. 现代化部署方案考虑采用现代化部署方式容器化使用Docker打包应用编排工具Kubernetes管理容器服务网格Istio处理服务间通信不可变基础设施每次部署创建新实例蓝绿部署实现零停机发布# Kubernetes部署示例 kubectl create deployment user-management \ --imageregistry.example.com/user-management:1.0.0 \ --port8080 kubectl expose deployment user-management \ --typeLoadBalancer \ --port80 \ --target-port808020. 持续学习与改进技术不断演进建议定期评估新技术可行性参加技术社区活动进行内部技术分享建立反馈机制收集用户意见通过A/B测试验证改进效果// 新技术评估示例 - 响应式编程 GetMapping(/users) public FluxUser listUsersReactive() { return userRepository.findAll(); }