苍穹外卖第一天：笔记

最新推荐文章于 2024-06-13 10:26:45 发布

魏时尚早

最新推荐文章于 2024-06-13 10:26:45 发布

阅读量994

点赞数 16

分类专栏：苍穹外卖文章标签： spring boot

本文链接：https://blog.csdn.net/weixin_75184535/article/details/138772764

版权

苍穹外卖专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、软件开发整体介绍

1.软件开发流程：需求分析→设计→编码→测试→上线运维

2.角色分工

3.软件环境：开发环境（development）、测试环境（testing）、生产环境（production）

二、项目介绍

1.单个商家

2.管理端：商家web页面、用户端：微信端

3.产品原型：静态html

4.技术选型：技术框架、中间件

三、前端环境搭建

1.整体结构

前端：管理端（Web）、用户端（小程序）

后端：后端服务（Java）

locahost（nginx默认80）

四、后端环境搭建

1.项目整体结构

sky-take-out：maven父工程、统一管理依赖版本，聚合其他子模块：

sky-common：通用，存放公共类，例如：工具类、常量类、异常类
sky-pojo：存放实体类、VO、DTO等
sky-server：后端服务，富南方配置文件、Controller、Service、Mapper等

2.三个主要目录结构

sky-common：

constant常量
context上下文
enumeration枚举类
exception异常
json处理json格式
properties属性
result统一返回数据格式
utils工具类

sky-pojo（Plain Old Java Object"的缩写，意为简单的旧Java对象）：

Entity：实体，通常和数据库中的表对应
DTO：数据传输对象，比如：前端过来是一个json对象，后端使用dto变成java对象
VO：视图对象，为前端展示数据提供的对象
POJO：普通的java对象，只有属性和对应的getter和setter

sky-server后端服务模块：

配置文件
配置类
拦截器
controller
service
mapper
启动类

3.使用Git进行版本控制

.gitigore：git管理忽略的文件

创建git本地仓库：

3.1 点击“VCS”→创建create git
3.2 点击“commit提交”

创建git远程仓库：

3.3 gitee.com→点击“+”→创建仓库点击“复制”

将本地文件推送到git远程仓库

3.3 推送

4.数据库环境搭建

5.前后端联调

启动：Skyapplication启动类
断点

- 下一步：一行一行
- 放行：到达下一个断点

登录功能：

（1）查数据库中用户名和密码是否正确，账户的状态是否被锁定，抛出相应的异常

（2）生成jwt：JwtUtil工具类根据秘钥（配置属性类JwtProperties中通过注解@ConfigurationProperties(prefix = "sky.jwt")指向application的sky.jwt属性，为了方便修改）、ttl过期时间（同理，跟秘钥一样）、字段“employee”和员工的id组成一个HashMap的形式生成token

（3）将相应属性（id、用户名、姓名）和token（jwt令牌）通过builder（对象需要加注解@Builder）封装成一个对象

nginx反向代理和负载均衡

前端发送请求，是如何请求到后端服务器的？

nginx反向代理：将前端发送的动态请求由nginx转发到后端服务器，实现跨域问
nginx反向代理的好处

- （1）负载均衡：将大量请求按照我们制定的方式均衡的分配给集群中的多台服务器
- （2）保证后端服务安全（nginx相当于一个保安，所有请求都必须经过他的转发才能到达后端服务）
- （3）提高访问速度（之间有相同的请求，nginx有缓存，有缓存的不用再向后端服务发送请求了，它直接发送了）

nginx反向代理的配置方式

监听到请求地址中有/api/就变成…..

负载均衡的配置方式

在nginx-1.20.2/conf/nginx.conf中配置

默认平均转发（轮询）到后端的两个服务器中

nginx负载均衡策略（不平均）：

五、完善登录功能

问题：员工表中的密码是明文存储的，安全性太低

思路：
将密码加密后存储
使用MD5加密方式对明文密码加密。

MD5

MD5信息摘要算法message-digest algorithm，单向不可逆，产生一个128位（16位字节）的散列值

有人说md5是可逆的，有专门网站就可以逆转？

- MD5被称为不可逆的，是因为在理论上，给定任意长度的输入，MD5会生成一个唯一的128位哈希值。但由于MD5的哈希长度固定为128位，而输入长度是不固定的，因此存在多个不同的输入可能会生成相同的MD5哈希值，这种情况称为哈希碰撞。因为哈希碰撞的存在，MD5在一定程度上失去了不可逆性。因此，尽管在大多数情况下，根据MD5哈希值无法还原原始输入，但在特定情况下，有可能通过寻找哈希碰撞来破解哈希值。因此，MD5不再被推荐用于安全性要求高的场景，而是被更安全的哈希算法如SHA-256所取代。

比对：将一个明文进行加密处理之后，再跟另一个密文进行比对

123456→e10adc3949ba59abbe56e057f20f883e

代码实现MD5加密的步骤

1.修改数据库中的明文密码，改为MD5加密后的密文

2.修改java代码，前端提交的密码进行MD5加密后再跟数据库中密码比对

借助工具类DigestUtils（spring默认提供的）

// 将前段传过来的明文密码进行md5加密，.getBytes()方法将字符串变成数组
password=DigestUtils.md5DigestAsHex(password.getBytes());

六、导入接口文档

Yapi接口管理平台：YApi Pro-高效、易用、功能强大的可视化接口管理平台，Yapi是设计阶段使用的工具，管理和维护接口。Swagger是在开发阶段使用的框架，帮助后端开发人员做后端接口的测试。

1.创建

2.选择刚刚创建的项目

3.选择json文件进行导入

七、Swagger

Swagger介绍：
后端可以生成接口文档，以及在线接口调试页面
knife4j是为java MVC框架集成Swagger生成Api文档的增强解决方案

使用方式

1.导入nkife4j的maven坐标

<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>

2.在配置类中加入knife4j相应配置

/**
     * 通过knife4j生成接口文档
     * @return
     */
@Bean
public Docket docket() {
    log.info("准备生成接口文档...");
    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;
}

3.设置静态资源映射，否则接口文档页面无法访问

/**
     * 设置静态资源映射
     * @param registry
     */
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
log.info("开始设置静态资源映射...");
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

接口文档地址：localhost:8080/doc.html

补充

设置文档位置：sky-take-out\sky-server\src\main\java\com\sky\config\WebMvcConfiguration.java

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() {
        log.info("准备生成接口文档...");
        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) {
        log.info("开始设置静态资源映射...");
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

swagger的常用注解

package com.sky.controller.admin;

import com.sky.constant.JwtClaimsConstant;
import com.sky.dto.EmployeeDTO;
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 io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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
@Api(tags="员工相关接口")
public class EmployeeController {

    @Autowired
    private EmployeeService employeeService;
    @Autowired
    private JwtProperties jwtProperties;

    /**
     * 登录
     *
     * @param employeeLoginDTO
     * @return
     */
    @PostMapping("/login")
    @ApiOperation("员工登录")
    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")
    @ApiOperation("员工退出")
    public Result<String> logout() {
        return Result.success();c
    }



    /**
     * @author : Administrator
     * @date   : 2024/5/11
     * @param  : [employeeDTO]
     * @return : com.sky.result.Result
     * @description : 新增员工
     */
    @PostMapping
    @ApiOperation("新增员工")
    public Result save(@RequestBody  EmployeeDTO employeeDTO){
        log.info("新增员工:{}",employeeDTO);
        employeeService.save(employeeDTO);
        return Result.success();
    }

}