2024-03-02 后端开发环境搭建-nginx反向代理和负载均衡-接口文档导入swagger

后端环境搭建

对工程的每个模块作用说明:

序号名称说明1sky-take-outmaven父工程,统一管理依赖版本,聚合其他子模块2sky-common子模块,存放公共类,例如:工具类、常量类、异常类等3sky-pojo子模块,存放实体类、VO、DTO等4sky-server子模块,后端服务,存放配置文件、Controller、Service、Mapper等

分析sky-common模块的每个包的作用:

名称说明constant存放相关常量类context存放上下文类enumeration项目的枚举类存储exception存放自定义异常类json处理json转换的类properties存放SpringBoot相关的配置属性类result返回结果类的封装utils常用工具类

分析sky-pojo模块的每个包的作用:

名称说明Entity实体,通常和数据库中的表对应DTO数据传输对象,通常用于程序中各层之间传递数据VO视图对象,为前端展示数据提供的对象POJO普通Java对象,只有属性和对应的getter和setter

分析sky-server模块的每个包的作用:

名称说明config存放配置类controller存放controller类interceptor存放拦截器类mapper存放mapper接口service存放service类SkyApplication启动类

必须做的: 通过断点跟踪登录功能的执行

@Builder 是 Lombok 提供的一个注解,用于自动生成构建器模式(Builder Pattern)相关的代码,以简化 Java 类的构建过程。

使用 @Builder 注解可以在编译时自动生成一个建造者类,该建造者类包含了类中所有非静态字段的 setter 方法,并提供一个 build 方法用于创建类的实例。

@PostMapping("/login")

public Result login(@RequestBody EmployeeLoginDTO employeeLoginDTO) {

log.info("员工登录:{}", employeeLoginDTO);

Employee employee = employeeService.login(employeeLoginDTO);

//登录成功后,生成jwt令牌

Map claims = new HashMap<>();

claims.put(JwtClaimsConstant.EMP_ID, employee.getId());

String token = JwtUtil.createJWT(

// 这里获取密钥的方式是 @Data下的get方法

// 创建的bean对象通过@ConfigurationProperties注解读取相应的配置前缀

jwtProperties.getAdminSecretKey(),

jwtProperties.getAdminTtl(),

claims);

// EmployeeLoginVO类通过@Build注解,创建builder()的方代替了直接new对象的方式

EmployeeLoginVO employeeLoginVO = EmployeeLoginVO.builder()

.id(employee.getId())

.userName(employee.getUsername())

.name(employee.getName())

.token(token)

.build();

return Result.success(employeeLoginVO);

}

注入的jwtProperties对象

@Component

@ConfigurationProperties(prefix = "sky.jwt") // 通过这个注解在创建bean对象时从配置文件中获取与前缀匹配的属性值传入

@Data // 必须同时标注@Data,提供getter setter方法

public class JwtProperties {

/**

* 管理端员工生成jwt令牌相关配置

*/

private String adminSecretKey;

private long adminTtl;

private String adminTokenName;

/**

* 用户端微信用户生成jwt令牌相关配置

*/

private String userSecretKey;

private long userTtl;

private String userTokenName;

}

nginx反向代理和负载均衡

点击登录:

前端请求地址:http://localhost/api/employee/login

后端接口地址:http://localhost:8080/admin/employee/login

web服务器如何把前端地址转发给后端服务器呢?

nginx 反向代理的好处:

提高访问速度 因为nginx本身可以进行缓存,如果访问的同一接口,并且做了数据缓存,nginx就直接可把数据返回,不需要真正地访问服务端,从而提高访问速度。 进行负载均衡 所谓负载均衡,就是把大量的请求按照我们指定的方式均衡的分配给集群中的每台服务器。 保证后端服务安全 因为一般后台服务地址不会暴露,所以使用浏览器不能直接访问,可以把nginx作为请求访问的入口,请求到达nginx后转发到具体的服务中,从而保证后端服务的安全。

# 反向代理,处理管理端发送的请求

location /api/ {

proxy_pass http://localhost:8080/admin/;

#proxy_pass http://webservers/admin/;

}

当在访问http://localhost/api/employee/login,nginx接收到请求后转到http://localhost:8080/admin/,故最终的请求地址为http://localhost:8080/admin/employee/login,和后台服务的访问地址一致。

nginx 负载均衡

当如果服务以集群的方式进行部署时,那nginx在转发请求到服务器时就需要做相应的负载均衡。其实,负载均衡从本质上来说也是基于反向代理来实现的,最终都是转发请求。

nginx 负载均衡的配置方式:

upstream webservers{

server 192.168.100.128:8080;

server 192.168.100.129:8080;

}

server{

listen 80;

server_name localhost;

location /api/{

proxy_pass http://webservers/admin;#负载均衡 #这里的webservers就是引用的上面的设定

}

}

**upstream:**如果代理服务器是一组服务器的话,我们可以使用upstream指令配置后端服务器组。

如上代码的含义是:监听80端口号, 然后当我们访问 http://localhost:80/api/…/…这样的接口的时候,它会通过 location /api/ {} 这样的反向代理到 http://webservers/admin,根据webservers名称找到一组服务器,根据设置的负载均衡策略(默认是轮询)转发到具体的服务器。

nginx 负载均衡策略:

名称说明轮询默认方式weight权重方式,默认为1,权重越高,被分配的客户端请求就越多ip_hash依据ip分配方式,这样每个访客可以固定访问一个后端服务least_conn依据最少连接方式,把请求优先分配给连接数少的后端服务url_hash依据url分配方式,这样相同的url会被分配到同一个后端服务fair依据响应时间方式,响应时间短的服务将会被优先分配

完善登录功能

MD5单向加密,修改登录功能中的密码为md5加密方式,利用spring中的库

password = DigestUtils.md5DigestAsHex(password.getBytes());

导入接口文档 TODO

接口文档导入到管理平台,为我们后面业务开发做好准备

第一步:定义接口,确定接口的路径、请求方式、传入参数、返回参数。

第二步:前端开发人员和后端开发人员并行开发,同时,也可自测。

第三步:前后端人员进行连调测试。

第四步:提交给测试人员进行最终测试。

在Yapi创建两个项目,并上传json格式的接口文档,访问地址是http://yapi.pro/

Swagger

用于生成、描述、调用和可视化 RESTful 风格的 Web 服务(https://swagger.io/)

Spring已经将Swagger纳入自身的标准,建立了Spring-swagger项目,现在叫Springfox。通过在项目中引入Springfox ,即可非常简单快捷的使用Swagger。

5.2 使用步骤

导入 knife4j 的maven坐标 在pom.xml中添加依赖

com.github.xiaoymin

knife4j-spring-boot-starter

在配置类中加入 knife4j 相关配置 WebMvcConfiguration.java /**

* 通过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;

}

设置静态资源映射,否则接口文档页面无法访问 WebMvcConfiguration.java /**

* 设置静态资源映射

* @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/");

}

**思考:**通过 Swagger 就可以生成接口文档,那么我们就不需要 Yapi 了?

1、Yapi 是设计阶段使用的工具,管理和维护接口

2、Swagger 在开发阶段使用的框架,帮助后端开发人员做后端的接口测试

5.3 常用注解

通过注解可以控制生成的接口文档,使接口文档拥有更好的可读性,常用注解如下:

注解说明@Api用在类上,例如Controller,表示对类的说明@ApiModel用在类上,例如entity、DTO、VO@ApiModelProperty用在属性上,描述属性信息@ApiOperation用在方法上,例如Controller的方法,说明方法的用途、作用

在要传给前端的数据类上或者controller类上加上注解,作为在生成接口文档时的说明

相关链接

评论可见,请评论后查看内容,谢谢!!!
 您阅读本篇文章共花了: