java架构一/1：微服务电商/地基/登录

一、构建聚合工程Java-Mavenfoodie-dev为父工程其他为子模块。foodie-dev-api的pom.xml引入依赖-service-service引入-mapper-mapper引入-pojo-pojo引入-common。二、使用PDMan进行数据库建模可以生成表图和表创建或版本更新等功能。三、整合springboot1.pom.xml这步难在版本springbootjdkMySQL等等有问题让AI去寻找协调的依赖即可parent groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-parent/artifactId version3.2.0/version relativePath/ /parent properties project.build.sourceEncodingUTF-8/project.build.sourceEncoding project.reporting.outputEncodingUTF-8/project.reporting.outputEncoding maven.compiler.source17/maven.compiler.source maven.compiler.target17/maven.compiler.target java.version17/java.version /properties dependencies !-- Spring Boot 基础 -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter/artifactId /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-configuration-processor/artifactId optionaltrue/optional /dependency !-- MyBatis-Plus兼容 Spring Boot 3.x -- dependency groupIdcom.baomidou/groupId artifactIdmybatis-plus-boot-starter/artifactId version3.5.5/version exclusions exclusion groupIdorg.mybatis/groupId artifactIdmybatis-spring/artifactId /exclusion /exclusions /dependency !-- MySQL 8 驱动 -- dependency groupIdcom.mysql/groupId artifactIdmysql-connector-j/artifactId version8.2.0/version /dependency !-- Lombok -- dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId version1.18.30/version scopeprovided/scope /dependency /dependencies2.application.yml# Web 访问端口号server:port: 8088tomcat:uri-encoding: UTF-8max-http-header-size: 80KB############################################################## 配置数据源信息#############################################################spring:datasource:type: com.zaxxer.hikari.HikariDataSourcedriver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://192.168.64.128:3306/foodie-shop-dev?useUnicodetruecharacterEncodingUTF-8useSSLfalseserverTimezoneAsia/ShanghaiautoReconnecttrueallowPublicKeyRetrievaltrueusername: rootpassword: roothikari:connection-timeout: 30000 # 连接超时时间毫秒minimum-idle: 5 # 最小连接数maximum-pool-size: 20 # 最大连接数auto-commit: true # 自动提交idle-timeout: 600000 # 空闲连接最大存活时间毫秒pool-name: DateSourceHikariCP # 连接池名字max-lifetime: 1800000 # 连接的最大生命周期毫秒connection-test-query: SELECT 1 # 连接测试查询############################################################## MyBatis 配置#############################################################mybatis:type-aliases-package: com.imooc.pojo # 所有 POJO 类所在包路径mapper-locations: classpath:mapper/*.xml # Mapper XML 文件路径############################################################## MyBatis-Plus 配置#############################################################mybatis-plus:configuration:map-underscore-to-camel-case: true # 开启驼峰命名转换log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 打印 SQL 日志global-config:db-config:id-type: auto # 主键自增logic-delete-field: deleted # 逻辑删除字段名logic-delete-value: 1 # 逻辑删除值logic-not-delete-value: 0 # 逻辑未删除值mybatis-plus在mybatis上只增强不修改所以我选择了MP因此springboot用3jdk17MySQL8......此外不论是mybatis还是MP都有相应的配置一键生成工具另一个项目可以自行去寻找。不过我直接用通义灵码的智能体插件告诉它需要生成的位置实体类的字段需要生成的文件也能快速生成一套基本的增删改查类pojomapperserviceserviceImpl。引入lombok依赖不用写实体类的getset方法只需要注解很方便。数据源url配置根据自己MySQL下载位置修改一般是localhost我是下载到了虚拟机Ubuntu中。数据库名foodie-shop-dev要与自己创建的一致。3.启动类package com.imooc; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.ComponentScan; SpringBootApplication ComponentScan(basePackages {com.imooc, org.n3r.idworker}) public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }三、api接口1.遵循restful编写风格2.可以使用PostMan去调试接口很简单自行学习swgger没使用教学教学视频中较老的swagger2因为版本不兼容所以改成了更新的openapiUI增强使用的knife4j能有更好看的界面。生成api文档更方便前端人员去调用接口去请求。文中未说明的依赖都是引入到父工程的pom中1.pom.xml!-- springdoc-openapi (替代 Swagger2兼容 Spring Boot 3.x) -- dependency groupIdorg.springdoc/groupId artifactIdspringdoc-openapi-starter-webmvc-ui/artifactId version2.3.0/version /dependency !-- knife4j 增强 UI (支持 OpenAPI 3) -- dependency groupIdcom.github.xiaoymin/groupId artifactIdknife4j-openapi3-jakarta-spring-boot-starter/artifactId version4.4.0/version /dependency2.Swagger.java位置foodie-dev\foodie-dev-api\src\main\java\com\imooc\config\Swagger.javapackage com.imooc.config; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Contact; import io.swagger.v3.oas.models.info.Info; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; // http://localhost:8088/swagger-ui/index.html // http://localhost:8088/doc.html Configuration public class Swagger { Bean public OpenAPI customOpenAPI() { return new OpenAPI() .info(new Info() .title(饕餮吃货 电商平台接口 api) .version(1.0.1) .description(饕餮吃货 电商平台接口 api 文档) .contact(new Contact() .name(imooc) .email(123imooc.com) .url(http://www.imooc.com))); } }3.application.yml############################################################ # # Knife4j 增强配置 # ############################################################ springdoc: api-docs: enabled: true path: /v3/api-docs swagger-ui: enabled: true path: /swagger-ui.html group-configs: - group: default paths-to-match: /** packages-to-scan: com.imooc.controller # Knife4j 增强 UI 配置 knife4j: enable: true setting: language: zh_cn swagger-model-name: 实体类列表四、跨域解决foodie-dev\foodie-dev-api\src\main\java\com\imooc\config\CorsConfig.javapackage com.imooc.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.cors.CorsConfiguration; import org.springframework.web.cors.UrlBasedCorsConfigurationSource; import org.springframework.web.filter.CorsFilter; Configuration public class CorsConfig { public CorsConfig(){ } Bean public CorsFilter corsFilter(){ // 1. 添加CORS配置信息 CorsConfiguration config new CorsConfiguration(); config.addAllowedOrigin(http://localhost:8080); // 是否发送cookie信息 config.setAllowCredentials(true); // 允许的请求方式 config.addAllowedMethod(*); // 允许的header config.addAllowedHeader(*); // 2. 为URL添加映射路径 UrlBasedCorsConfigurationSource corsSource new UrlBasedCorsConfigurationSource(); corsSource.registerCorsConfiguration(/**, config); return new CorsFilter(corsSource); } }五、基本功能实现1.判断用户名是否存在1.UserServiceImpl主要用于前端页面的用户名校验用户填写密码前就能校验出结果。Autowired private UserMapper userMapper; /** * 判断用户名是否存在 * param username */ Override public boolean queryUsernameIsExist(String username) { if (StringUtils.isBlank(username)) { return false; } LambdaQueryWrapperUsers wrapper new LambdaQueryWrapper(); wrapper.eq(Users::getUsername, username); Users user this.baseMapper.selectOne(wrapper); return user ! null; }2.PassportController** * 校验用户名是否存在 * * param username 用户名 * return 200-OK(用户名可用), 500-用户名已存在或为空 */ Operation(summary 用户名是否存在, description 用户名是否存在) GetMapping() public IMOCCJSONResult checkUsername( Parameter(description 用户名, required true) RequestParam String username) { // 1. 校验用户名是否为空 if (StringUtils.isBlank(username)) { return IMOCCJSONResult.errorMsg(用户名不能为空); } // 2. 校验用户名是否存在 boolean isExist userService.queryUsernameIsExist(username); if (isExist) { return IMOCCJSONResult.errorMsg(用户名已存在请换一个试试); } // 3. 用户名可用 return IMOCCJSONResult.ok(用户名可用); }2.注册功能1.User.javapackage com.imooc.pojo; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; import java.io.Serializable; import java.util.Date; /** * 用户实体类 */ Data TableName(users) public class Users implements Serializable { private static final long serialVersionUID 1L; /** * 主键 ID */ TableId(value id, type IdType.ASSIGN_UUID) private String id; /** * 用户名 */ private String username; /** * 密码 */ private String password; /** * 昵称 */ private String nickname; /** * 真实姓名 */ private String realname; /** * 头像 */ private String face; /** * 手机号 */ private String mobile; /** * 邮箱 */ private String email; /** * 性别 (1:男 0:女 2:保密) */ private Integer sex; /** * 生日 */ private Date birthday; /** * 创建时间 */ private Date createdTime; /** * 更新时间 */ private Date updatedTime; }2.UserServiceImpl/** * 用户服务实现类 */ Service public class UserServiceImpl extends ServiceImplUserMapper, Users implements UserService { Autowired public Sid sid; private static final String USER_FACE https://img.zcool.cn/community/01a2f05e8d07e45f4ab05c1f60b4df.jpg; Autowired private UserMapper userMapper; /** * 创建用户 * param userBo */ Override public Users createUser(UserBo userBo) { String userId sid.nextShort(); Users user new Users(); user.setId(userId); user.setUsername(userBo.getUsername()); try { user.setPassword(MD5Utils.getMD5Str(userBo.getPassword())); } catch (Exception e) { throw new RuntimeException(e); } user.setNickname(userBo.getUsername()); user.setFace(USER_FACE); user.setBirthday(DateUtil.stringToDate(1900-01-01)); user.setSex(Sex.secret.type); user.setCreatedTime(new Date()); user.setUpdatedTime(new Date()); userMapper.insert(user); return user; }这段涉及很多其他的知识点1.createUser(UserBo userBo)用户注册时输入包含用户名密码确认密码用于前端传入而后端不需要对确认密码进行其他操作因此自定义UserBo用于参数传入且不用写过长的参数保持优雅。package com.imooc.pojo.bo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; Schema(description 用户对象 BO) Data public class UserBo { Schema(description 用户名, example imooc, required true) private String username; Schema(description 密码, example 123456, required true) private String password; Schema(description 确认密码, example 123456, required false) private String confirmPassword; }2.sid.nextShort()使用雪花算法来生成全局唯一id支持分布式3.MD5Utils.getMD5Str(userBo.getPassword())用到了MD5加密我们把设置的密码加密后存到数据库中显示但实际用户登录还是用ta原先设置好的那串。!-- Apache 工具类 -- dependency groupIdcommons-codec/groupId artifactIdcommons-codec/artifactId version1.11/version /dependency dependency groupIdorg.apache.commons/groupId artifactIdcommons-lang3/artifactId version3.4/version /dependency dependency groupIdorg.apache.commons/groupId artifactIdcommons-io/artifactId version1.3.2/version /dependency4.DateUtil.stringToDate(1900-01-01)将字符串转换成日期。5.user.setSex(Sex.secret.type)用枚举类设置性别一目了然而非数字。3.PassportControllerpackage com.imooc.controller; Tag(name 注册登录, description 用于用户注册登录相关接口) RestController RequestMapping(/passport) public class PassportController { Autowired private UserService userService; /** * 用户注册 * * param userBo 用户名 * return 200-OK(用户名可用), 500-用户名已存在或为空 */ Operation(summary 用户注册, description 用户注册) PostMapping(/regist) public IMOCCJSONResult regist(RequestBody UserBo userBo, HttpServletRequest request, HttpServletResponse response) throws Exception { String username userBo.getUsername(); String password userBo.getPassword(); String confirmPassword userBo.getConfirmPassword(); // 0. 判断用户和密码是否为空 if (StringUtils.isBlank(username) || StringUtils.isBlank(password) || StringUtils.isBlank(confirmPassword)) { return IMOCCJSONResult.errorMsg(用户名或密码不能为空); } // 1. 校验用户名是否存在 boolean isExist userService.queryUsernameIsExist(username); if (isExist) { return IMOCCJSONResult.errorMsg(用户名已存在请换一个试试); } // 2.密码长度不能少于 6 位 if (password.length() 6) { return IMOCCJSONResult.errorMsg(密码长度不能少于 6 位); } // 3.判断两次密码是否一致 if (!password.equals(confirmPassword)) { return IMOCCJSONResult.errorMsg(两次密码不一致); } // 4. 实现注册 Users userResult userService.createUser(userBo); userResult setNullProperty(userResult); CookieUtils.setCookie(request, response, user, JsonUtils.objectToJson(userResult), true); return IMOCCJSONResult.ok(); }这有一个自定义响应数据结构类IMOCCJSONResultpackage com.imooc.utils; import com.fasterxml.jackson.annotation.JsonInclude; import lombok.Data; /** * 自定义响应数据结构 * 本类可提供给 H5/ios/安卓/公众号/小程序 使用 * 前端接受此类数据 (jsonobject) 后可自行根据业务去实现相关功能 * * 200: 表示成功 * 500: 表示错误错误信息在 msg 字段中 * 501: bean 验证错误不管多少个错误都以 map 形式返回 * 502: 拦截器拦截到用户 token 出错 * 555: 异常抛出信息 * 556: 用户 qg 校验异常 */ Data JsonInclude(JsonInclude.Include.NON_NULL) public class IMOCCJSONResult { /** * 响应状态码 */ private Integer status; /** * 响应消息 */ private String msg; /** * 响应数据 */ private Object data; /** * 响应时间戳 */ private Long timestamp; public IMOCCJSONResult() { this.timestamp System.currentTimeMillis(); } /** * 成功响应不带数据 */ public static IMOCCJSONResult build(Integer status, String msg) { IMOCCJSONResult result new IMOCCJSONResult(); result.setStatus(status); result.setMsg(msg); return result; } /** * 成功响应带数据 */ public static IMOCCJSONResult build(Integer status, String msg, Object data) { IMOCCJSONResult result new IMOCCJSONResult(); result.setStatus(status); result.setMsg(msg); result.setData(data); return result; } /** * 成功响应200 */ public static IMOCCJSONResult ok() { return build(200, OK); } /** * 成功响应200带数据 */ public static IMOCCJSONResult ok(Object data) { return build(200, OK, data); } /** * 错误响应500 */ public static IMOCCJSONResult errorMsg(String msg) { return build(500, msg); } /** * 错误响应500带数据 */ public static IMOCCJSONResult errorMsg(String msg, Object data) { return build(500, msg, data); } }3.登录功能1.UserServiceImpl/** * 检索用户名和密码是否匹配用于登录 * param username * param password */ Override public Users queryUserForLogin(String username, String password) { LambdaQueryWrapperUsers wrapper new LambdaQueryWrapper(); wrapper.eq(Users::getUsername, username); wrapper.eq(Users::getPassword, password); Users result userMapper .selectOne(wrapper); return result; }2.PassportController/** * 用户登录 * * param userBo 用户输入 */ Operation(summary 用户登录, description 用户登录) PostMapping(/login) public IMOCCJSONResult login(RequestBody UserBo userBo, HttpServletRequest request, HttpServletResponse response) throws Exception { String username userBo.getUsername(); String password userBo.getPassword(); // 0. 判断用户和密码是否为空 if (StringUtils.isBlank(username) || StringUtils.isBlank(password)) { return IMOCCJSONResult.errorMsg(用户名或密码不能为空); } // 1. 实现登录 Users userResult userService.queryUserForLogin(username, MD5Utils.getMD5Str(password)); if (userResult null) { return IMOCCJSONResult.errorMsg(用户名或密码不正确); } // 数据敏感信息隐藏 userResult setNullProperty(userResult); // 保存会话 CookieUtils.setCookie(request, response, user, JsonUtils.objectToJson(userResult), true); return IMOCCJSONResult.ok(userResult); } private Users setNullProperty(Users userResult) { userResult.setPassword(null); userResult.setMobile(null); userResult.setEmail(null); userResult.setCreatedTime(null); userResult.setUpdatedTime(null); return userResult; }注册和登录后都需要把敏感信息设置为空然后设置cookie用于身份令牌识别。这部分涉及一个JsonUtils.objectToJson(userResult)在com/imooc/utils下。!-- Jakarta Servlet API (兼容 Spring Boot 3.x) -- dependency groupIdjakarta.servlet/groupId artifactIdjakarta.servlet-api/artifactId version6.0.0/version scopeprovided/scope /dependency4.登出/** * 用户退出登录 * param userId 用户ID */ Operation(summary 用户退出登录, description 用户退出登录) PostMapping(/logout) public IMOCCJSONResult logout(RequestParam String userId, HttpServletRequest request, HttpServletResponse response) { // 清除用户相关信息的 cookie CookieUtils.deleteCookie(request, response, user); // TODO 用户退出登录需要清空购物车 // TODO 分布式会话中需要清除用户数据 return IMOCCJSONResult.ok(); }六、日志记录1.依赖!-- Spring Boot 基础 -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter/artifactId exclusions exclusion groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-logging/artifactId /exclusion /exclusions /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-aop/artifactId /dependency !--引入日志依赖 抽象层 与 实现层-- dependency groupIdorg.slf4j/groupId artifactIdslf4j-api/artifactId version1.7.21/version /dependency dependency groupIdorg.slf4j/groupId artifactIdslf4j-log4j12/artifactId version1.7.21/version /dependency2.log4j.propertieslog4j.rootLoggerDEBUG,stdout,file log4j.additivity.org.apachetrue log4j.appender.stdoutorg.apache.log4j.ConsoleAppender log4j.appender.stdout.thresholdINFO log4j.appender.stdout.layoutorg.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern%-5p %c{1}:%L - %m%n log4j.appender.fileorg.apache.log4j.DailyRollingFileAppender log4j.appender.file.layoutorg.apache.log4j.PatternLayout log4j.appender.file.DatePattern.yyyy-MM-dd-HH-mm log4j.appender.file.layout.ConversionPattern%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n log4j.appender.file.ThresholdINFO log4j.appender.file.appendtrue log4j.appender.file.File/workspaces/logs/foodie-api/imooc.log3.ServiceLogAspect.javafoodie-dev\foodie-dev-api\src\main\java\com\imooc\aspect\ServiceLogAspect.javapackage com.imooc.aspect; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; Aspect Component public class ServiceLogAspect { private static final Logger log LoggerFactory.getLogger(ServiceLogAspect.class); /** * A0P通知: * 1.前置通知:在方法调用之前执行 * 2.后置通知:在方法正常调用之后执行 * 3.⭐环绕通知:在方法调用之前和之后都分别可以执行的通知 * 4.异常通知:如果在方法调用过程中发生异常则通知 * 5.最终通知:在方法调用之后执行 */ /** * 切面表达式:execution代表所要执行的表达式主体 * 第一处 * 代表方法返回所有类型 * 第二处 包名代表aop监控的类所在的包 * 第三处 ..代表该包以及其子包下的所有类 * 第四处 *代表(所有)类名 * 第五处 *代表类中的方法名(..)表示方法中的任何参数 */ Around(execution(* com.imooc.service.impl..*.*(..))) public Object recordTimeLog(ProceedingJoinPoint joinPoint) throws Throwable { log.info(开始执行{}.{}, joinPoint.getTarget().getClass().getSimpleName(), joinPoint.getSignature().getName()); // 记录开始时间 long begin System.currentTimeMillis(); // 执行目标 service Object result joinPoint.proceed(); // 记录结束时间 long end System.currentTimeMillis(); long takeTime end - begin; if (takeTime 3000) { log.error(执行结束耗时{}毫秒, takeTime); } else if (takeTime 2000) { log.warn(执行结束耗时{}毫秒, takeTime); } else { log.info(执行结束耗时{}毫秒, takeTime); } return result; } }