springboot苍穹外卖实战：二、nginx反向代理和负载均衡配置+MD5加密+Apifox导入接口文档+Swagger（knife4j版、含常用接口注解）

本专栏只是黑马课程的相关笔记，个人自学使用，请支持B站上黑马的原版视频。
该文章对应视频Day01-09到Day01-14（含14）。

nginx反向代理和负载均衡

观察项目代码，我们可以发现
前端请求地址：http://localhost/api/employee/login
后端接口地址：http://localhost:8080/admin/employee/login
很明显，两个地址不一致，那是如何请求到后端服务的呢？

这便是通过nginx来反向代理，前端的请求通过nginx转发给后端，从而实现前后端不同的地址之间的映射。

前后端接口地址

具体怎么看的前端的接口地址呢，其实我们执行登录操作的时候可以抓一下包。

具体怎么看的后端接口地址，是如下代码

nginx反向代理和负载均衡的配置

反向代理的配置

server{
    listen 80;
    server_name localhost;
    
    location /api/{
        proxy_pass http://localhost:8080/admin/; #反向代理
    }
}

如上代码的含义是：监听80端口号， 当我们访问 http://localhost:80/api/../..这样的接口的时候，它通过了 location /api/ {} 这样的匹配，从而被nginx反向代理到 http://localhost:8080/admin/上来。

负载均衡配置

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;#负载均衡
    }
}

upstream：如果代理服务器是一组服务器的话，我们可以使用upstream指令配置后端服务器组。其后面的名称可自定义，如这里的webservers，但要上下保持一致。

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

nginx反向代理的优势和负载均衡策略和对应配置

那为什么不直接通过浏览器直接请求后台服务端，需要通过nginx反向代理呢？

nginx反向代理的优势如下

• 提高访问速度

  因为nginx本身可以进行缓存，如果访问的同一接口，并且做了数据缓存，nginx就直接可把数据返回，不需要真正地访问服务端，从而提高访问速度。

• 进行负载均衡

  所谓负载均衡,就是把大量的请求按照我们指定的方式均衡的分配给集群中的每台服务器。

• 保证后端服务安全

  把nginx作为请求访问的入口，请求到达nginx后转发到具体的服务中，从而保证后端服务的安全。

nginx 负载均衡策略：

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

轮询：

upstream webservers{
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

weight:

upstream webservers{
    server 192.168.100.128:8080 weight=90;
    server 192.168.100.129:8080 weight=10;
}

ip_hash:

upstream webservers{
    ip_hash;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

least_conn:

upstream webservers{
    least_conn;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

url_hash:

upstream webservers{
    hash &request_uri;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

fair:

upstream webservers{
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
    fair;
}

MD5加密

此时我们代码还存在一些问题，譬如员工表中的密码是明文存储，安全性太低。所以我们修改数据库中明文密码，改为MD5加密后的密文。

打开employee表，修改密码123456为

e10adc3949ba59abbe56e057f20f883e

注意不要用回车或者空格，直接点更新即可。

找到项目中的TODO，然后加入加密代码：

// TODO 后期需要进行md5加密，然后再进行比对
        password = DigestUtils.md5DigestAsHex(password.getBytes());

Apifox导入接口文档

Apifox是在设计阶段使用的工具，用来管理和维护接口。

在Apifox中新建两个HTTP项目，分别为“苍穹外卖管理端”和“苍穹外卖用户端”。
然后ctrl+o打开接口设置的导入。或者通过如下方式打开：

然后选择YApi格式，将资料中的day02的“项目接口”的两个json文档，分别拖拽到两个项目的这个页面进行导入，随后发现两个项目中新增接口。

Swagger（knife4j版）

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

导入依赖

在初始工程中sky-take-out的pom.xml已经导入了。

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

配置类添加配置并设置静态资源映射

sky-servcer下的com.sky.config.WebMvcConfiguration添加配置，初始工程也已经添加了。

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

sky-servcer下的com.sky.config.WebMvcConfiguration添加配置，初始工程也已经添加了。
设置静态资源映射

/**
     * 设置静态资源映射
     * @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/");
}

测试

浏览器中输入http://localhost:8080/doc.html，发现如下页面即测试成功。

常用注解

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

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