1 软件开发整体介绍
1.1 软件开发流程
| 需求分析 |
形成两个文档：需求规格说明书、产品原型
| 设计 |
UI 设计、数据库设计、接口设计
| 编码 |
项目代码，单元测试
| 测试 |
测试用例、测试报告
| 运维 |
软件环境安装、配置
1.2 角色分工
1.3 软件环境
- 开发环境（development）：开发人员在开发阶段使用的环境，一般外部用户无法访问
- 测试环境（testing）：专门给测试人员使用的环境，用于测试项目，一般外部用户无法访问
- 生产环境（production）：即线上环境，正式提供对外服务的环境
2 苍穹外卖项目介绍
2.1 项目介绍
2.2 产品原型
静态 HTML 页面
使用 Axure RP 设计
2.3 技术选型
展示项目中使用到的 技术框架 和 中间件 等
中间件（Middleware）是位于客户端和服务器之间的软件层，为不同的应用程序提供通信和数据管理的服务
如：
- 应用服务器（如 Tomcat，JBoss）
- 数据库连接池（如 HikariCP，c3p0）
- 消息队列（如 RabbitMQ，Kafka）
- 微服务框架（如 Spring Cloud，Istio）
- 缓存系统（如 Redis，Memcached）
- 容器编排工具（如 Kubernetes）
3 开发环境搭建
3.1 前端
使用 Nginx
Nginx 是一个高性能的 HTTP 和反向代理服务器
占用端口号 localhost:80 （或 localhost）
3.2 后端
// TODO（先复习一下mybatis、Maven高级）
3.2.1 使用 Git 进行版本控制
在 .gitignore 文件里面放置不需要 git 自动跟踪的文件名
提交
在 github 上，新建仓库，注意修改了默认分支名为“master”
复制 SSH 地址
在 IDEA 上推送（push）
3.2.2 数据库搭建
一共 11 张表：
建表：
3.2.3 前后端联调
注意后端的 JDBC 配置
启动后端
然后在前端登录
分析一下登录功能：
package com.sky.controller.admin;
import com.sky.constant.JwtClaimsConstant;
import com.sky.dto.EmployeeLoginDTO;
import com.sky.entity.Employee;
import com.sky.properties.JwtProperties;
import com.sky.result.Result;
import com.sky.service.EmployeeService;
import com.sky.utils.JwtUtil;
import com.sky.vo.EmployeeLoginVO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
/**
* 员工管理
*/
@RestController
@RequestMapping("/admin/employee")
@Slf4j
public class EmployeeController {
@Autowired
private EmployeeService employeeService;
@Autowired
private JwtProperties jwtProperties;
/**
* 登录
*
* @param employeeLoginDTO
* @return
*/
@PostMapping("/login")
public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) {
log.info("员工登录：{}", employeeLoginDTO);
Employee employee = employeeService.login(employeeLoginDTO);
//登录成功后，生成 jwt 令牌
Map<String, Object> claims = new HashMap<>();
claims.put(JwtClaimsConstant.EMP_ID, employee.getId());
String token = JwtUtil.createJWT(
jwtProperties.getAdminSecretKey(),
jwtProperties.getAdminTtl(),
claims);
EmployeeLoginVO employeeLoginVO = EmployeeLoginVO.builder()
.id(employee.getId())
.userName(employee.getUsername())
.name(employee.getName())
.token(token)
.build();
return Result.success(employeeLoginVO);
}
/**
* 退出
*
* @return
*/
@PostMapping("/logout")
public Result<String> logout() {
return Result.success();
}
}
关于jwtproperties（有@ConfigurationProperties注解，去配置文件中找sky jwt）
package com.sky.properties;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "sky.jwt") // 配置属性类
@Data
public class JwtProperties {
/**
* 管理端员工生成jwt令牌相关配置
*/
private String adminSecretKey;
private long adminTtl;
private String adminTokenName;
/**
* 用户端微信用户生成jwt令牌相关配置
*/
private String userSecretKey;
private long userTtl;
private String userTokenName;
}
关于JwtUtil
package com.sky.utils;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.nio.charset.StandardCharsets;
import java.util.Date;
import java.util.Map;
public class JwtUtil {
/**
* 生成jwt
* 使用Hs256算法, 私匙使用固定秘钥
*
* @param secretKey jwt秘钥
* @param ttlMillis jwt过期时间(毫秒)
* @param claims 设置的信息
* @return
*/
public static String createJWT(String secretKey, long ttlMillis, Map<String, Object> claims) {
// 指定签名的时候使用的签名算法，也就是header那部分
SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
// 生成JWT的时间
long expMillis = System.currentTimeMillis() + ttlMillis;
Date exp = new Date(expMillis);
// 设置jwt的body
JwtBuilder builder = Jwts.builder()
// 如果有私有声明，一定要先设置这个自己创建的私有的声明，这个是给builder的claim赋值，一旦写在标准的声明赋值之后，就是覆盖了那些标准的声明的
.setClaims(claims)
// 设置签名使用的签名算法和签名使用的秘钥
.signWith(signatureAlgorithm, secretKey.getBytes(StandardCharsets.UTF_8))
// 设置过期时间
.setExpiration(exp);
return builder.compact();
}
/**
* Token解密
*
* @param secretKey jwt秘钥 此秘钥一定要保留好在服务端, 不能暴露出去, 否则sign就可以被伪造, 如果对接多个客户端建议改造成多个
* @param token 加密后的token
* @return
*/
public static Claims parseJWT(String secretKey, String token) {
// 得到DefaultJwtParser
Claims claims = Jwts.parser()
// 设置签名的秘钥
.setSigningKey(secretKey.getBytes(StandardCharsets.UTF_8))
// 设置需要解析的jwt
.parseClaimsJws(token).getBody();
return claims;
}
}
3.3 nginx反向代理&负载均衡
4 完善登录
现在数据库中的密码以明文存储，安全性差
现在采用md5加密：
对密码123456加密后得到 e10adc3949ba59abbe56e057f20f883e
在数据库中保存
然后
password = DigestUtils.md5DigestAsHex(password.getBytes());
DigestUtils是 Apache Commons Codec 库中的一个工具类，它提供了一些静态方法来处理哈希和摘要算法。这个类使得在Java应用程序中生成消息摘要变得非常简单和直接
DigestUtils.md5DigestAsHex是 Apache Commons Codec 库中的一个方法，用于计算给定数据的MD5摘要，并将其转换为十六进制字符串
5 swagger
使用 Swagger 只需要按照规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面
官网:https://swagger.io/
Knife4j 是为 Java MVC 框架集成 Swagger 生成 Api 文档的增强解决方案
引入依赖：
使用方式：
1.导入 knife4j 的 maven 坐标
2.在配置类中加入 knife4j 相关配置
3.设置静态资源映射，否则接口文档页面无法访问
package com.sky.config;
import com.sky.interceptor.JwtTokenAdminInterceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* 配置类，注册web层相关组件
*/
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
@Autowired
private JwtTokenAdminInterceptor jwtTokenAdminInterceptor;
/**
* 注册自定义拦截器
*
* @param registry
*/
protected void addInterceptors(InterceptorRegistry registry) {
log.info("开始注册自定义拦截器...");
registry.addInterceptor(jwtTokenAdminInterceptor)
.addPathPatterns("/admin/**")
.excludePathPatterns("/admin/employee/login");
}
/**
* 通过knife4j生成接口文档
*
* @return
*/
@Bean
public Docket docket() {
ApiInfo apiInfo = new ApiInfoBuilder()
.title("苍穹外卖项目接口文档")
.version("2.0")
.description("苍穹外卖项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* 设置静态资源映射
*
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
输入 localhost:8080/doc.html
自动生成接口文档
还可以调试
5.1 Swagger 注解
通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性
然后访问 localhost:8080/doc.html
