【前端部署附录二】写给前端的 nginx 配置指南

2022-11-02 16:22:48 浏览数 (1)

大家好，我是山月，这是我最近新开的专栏：「前端部署系列」。包括 Docker、CICD 等内容，大纲图示如下：

大纲

示例代码开源，置于 Github 中，演示如何对真实项目进行部署上线。

「前端部署」系列正在更新: 17/18

三年经验的前端或多或少与 nginx 配置打过交道。

nginx 的重要性不言而喻。

本篇文章以前端的视角，介绍下 nginx 的常见配置。

1. 通过 docker 高效学习 nginx 配置

推荐一种高效学习 nginx 的方法: 「在本地使用 nginx 镜像并挂载 nginx 配置启动容器」。

Learning Nginx

通过以下 docker-compose 可秒级验证 nginx 配置，无疑是学习 nginx 的绝佳利器。

我将所有关于 nginx 的配置放置在 simple-deploy1，并且每一份配置对应 docker compose 中的一个 service，如以下 nginx、location、order1 就是 service。

代码语言：javascript复制
version: "3"
services:
  # 关于 nginx 最常见配置的学习
  nginx:
    image: nginx:alpine
    ports:
      - 8080:80
    volumes:
      - ./nginx.conf:/etc/nginx/conf.d/default.conf
      - .:/usr/share/nginx/html
  # 关于 location 的学习
  location: ...
  # 关于 location 匹配顺序的学习
  order1: ...

每次修改配置时，需要重启容器，可根据服务名学习指定内容。

代码语言：javascript复制
$ docker-compose up <service>

# 学习 nginx 最基础的配置
$ docker-compose up nginx

# 学习关于 location 的配置
$ docker-compose up location

本篇文章所有的 nginx 配置均可以通过 docker 来进行学习，并附全部代码及配置。

2. root 与 index

  • root: 静态资源的根路径。见文档 https://nginx.org/en/docs/http/ngx_http_core_module.html#root
  • index: 当请求路径以 / 结尾时，则自动寻找该路径下的 index 文件。见文档 https://nginx.org/en/docs/http/ngx_http_index_module.html#index

root 与 index 为前端部署的基础，在默认情况下 root 为 /usr/share/nginx/html，因此我们部署前端时，往往将构建后的静态资源目录挂载到该地址。

代码语言：javascript复制
server {
    listen       80;
    server_name  localhost;

    root   /usr/share/nginx/html;
    index  index.html index.htm;
}

3. location

location 用以匹配路由，配置语法如下。

代码语言：javascript复制
location [ = | ~ | ~* | ^~ ] uri { ... }

其中 uri 前可提供以下修饰符

  • = 精确匹配。优先级最高
  • ^~ 前缀匹配，优先级其次
  • ~ 正则匹配，优先级再次 (~* 只是不区分大小写，不单列)
  • / 通用匹配，优先级再次

为了验证所匹配的 location，我会在以下示例中添加一个自定义响应头 X-Config，可通过浏览器控制台网络面板验证其响应头。

代码语言：javascript复制
add_header X-Config B;

注意，我所有「配置文件中的链接可直接点击，避免了在 compose 配置文件中寻找映射端口号的不方便」。

3.1. location 修饰符验证

对于此四种修饰符可以在我的 nginx 下进行验证。

由于此处使用了 proxy_pass，因此需要 location2，api 两个服务一起启动，在 location2 服务中，可直接通过 service 名称作为 hostname 即 http://api:3000 访问 api 服务。

而 api 服务，为我自己写的一个 whoami 服务，用以打印出请求路径等信息，详见 shfshanyue/whoami2。

代码语言：javascript复制
$ docker-compose up location2 api

以下是关于验证 location 的配置文件，详见 shfshanyue/simple-daploy:learn-nginxs3

代码语言：javascript复制
server {
    listen       80;
    server_name  localhost;

    root   /usr/share/nginx/html;
    index  index.html index.htm;

    # 通用匹配，所有 /xxx 任意路径都会匹配其中的规则
    location / {
        add_header X-Config A;
        try_files  $uri $uri.html $uri/index.html /index.html;
    }

    # http://localhost:8120/test1           ok
    # http://localhost:8120/test1/          ok
    # http://localhost:8120/test18          ok
    # http://localhost:8120/test28          not ok
    location /test1 {
        # 可通过查看响应头来判断是否成功返回
        add_header X-Config B;
        proxy_pass http://api:3000;
    }

    # http://localhost:8120/test2           ok
    # http://localhost:8120/test2/          not ok
    # http://localhost:8120/test28          not ok
    location = /test2 {
        add_header X-Config C;
        proxy_pass http://api:3000;
    }

    # http://localhost:8120/test3           ok
    # http://localhost:8120/test3/          ok
    # http://localhost:8120/test38          ok
    # http://localhost:8120/hellotest3      ok
    location ~ .*test3.* {
        add_header X-Config D;
        proxy_pass http://api:3000;
    }

    # http://localhost:8120/test4           ok
    # http://localhost:8120/test4/          ok
    # http://localhost:8120/test48          ok
    # http://localhost:8120/test28          not ok
    location ^~ /test4 {
        # 可通过查看响应头来判断是否成功返回
        add_header X-Config E;
        proxy_pass http://api:3000;
    }
}

3.2. location 优先级验证

在我配置文件中，以 order 打头来命名所有优先级验证的 nginx 配置，此处仅仅以 order1 为例进行验证。

配置如下:

代码语言：javascript复制
# 以下配置，访问以下链接，其 X-Config 为多少
#
# http://localhost:8210/shanyue，为 B，若都是前缀匹配，则找到最长匹配的 location

server {
    root   /usr/share/nginx/html;

    # 主要是为了 shanyue 该路径，因为没有后缀名，无法确认其 content-type，会自动下载
    # 因此这里采用 text/plain，则不会自动下载
    default_type text/plain;

    location ^~ /shan {
        add_header X-Config A;
    }

    location ^~ /shanyue {
        add_header X-Config B;
    }
}

启动服务:

代码语言：javascript复制
$ docker-compose up order1

curl 验证:

当然也可以通过浏览器控制台网络面板验证，由于此处只需要验证响应头，则我们通过 curl --head 只发送 head 请求即可。

代码语言：javascript复制
# 查看其 X-Config 为 B
$ curl --head http://localhost:8210/shanyue
HTTP/1.1 200 OK
Server: nginx/1.21.4
Date: Fri, 03 Jun 2022 10:15:11 GMT
Content-Type: text/plain
Content-Length: 15
Last-Modified: Thu, 02 Jun 2022 12:44:23 GMT
Connection: keep-alive
ETag: "6298b0a7-f"
X-Config: B
Accept-Ranges: bytes

4. proxy_pass

proxy_pass 反向代理，也是 nginx 最重要的内容，这也是常用的解决跨域的问题。

当使用 proxy_pass 代理路径时，有两种情况

  1. 代理服务器地址不含 URI，则此时客户端请求路径与代理服务器路径相同。「强烈建议这种方式」
  2. 代理服务器地址含 URI，则此时客户端请求路径匹配 location，并将其 location 后的路径附在代理服务器地址后。
代码语言：javascript复制
# 不含 URI
proxy_pass http://api:3000;

# 含 URI
proxy_pass http://api:3000/;
proxy_pass http://api:3000/api;
proxy_pass http://api:3000/api/;

再举一个例子:

  1. 访问 http://localhost:8300/api3/hello，与以下路径匹配成功
  2. proxy_pass 附有 URI
  3. 匹配路径后多余的路径为 /hello，将其附在 proxy_pass 之后，得 http://api:3000/hello/hello
代码语言：javascript复制
location /api3 {
    add_header X-Config C;

    # http://localhost:8300/api3/hello -> proxy:3000/hello/hello
    proxy_pass http://api:3000/hello;
}

有点拗口，在我们试验环境有多个示例，使用以下代码启动可反复测试:

代码语言：javascript复制
$ docker-compose up proxy api

由于 proxy_pass 所代理的服务为 whoami，可打印出真实请求路径，可根据此进行测试

代码语言：javascript复制
server {
    listen       80;
    server_name  localhost;

    root   /usr/share/nginx/html;
    index  index.html index.htm;

    # 建议使用此种 proxy_pass 不加 URI 的写法，原样路径即可
    # http://localhost:8300/api1/hello -> proxy:3000/api1/hello
    location /api1 {
        # 可通过查看响应头来判断是否成功返回
        add_header X-Config A;
        proxy_pass http://api:3000;
    }

    # http://localhost:8300/api2/hello -> proxy:3000/hello
    location /api2/ {
        add_header X-Config B;
        proxy_pass http://api:3000/;
    }

    # http://localhost:8300/api3/hello -> proxy:3000/hello/hello
    location /api3 {
        add_header X-Config C;
        proxy_pass http://api:3000/hello;
    }

    # http://localhost:8300/api4/hello -> proxy:3000//hello
    location /api4 {
        add_header X-Config D;
        proxy_pass http://api:3000/;
    }
}

5. add_header

控制响应头。

由于很多特性都是通过响应头控制，因此基于此指令可做很多事情，比如:

  1. Cache
  2. CORS
  3. HSTS
  4. CSP
  5. ...

5.1. Cache

代码语言：javascript复制
location /static {
    add_header Cache-Control max-age=31536000;
}

5.2. CORS

代码语言：javascript复制
location /api {
    add_header Access-Control-Allow-Origin *;
}

5.3. HSTS

代码语言：javascript复制
location / {
    listen 443 ssl;

    add_header Strict-Transport-Security max-age=7200;
}

5.4. CSP

代码语言：javascript复制
location / {
    add_header Content-Security-Policy "default-src 'self';";
}

6. 作业

  • 初阶: 基于 docker 学习 nginx 配置，并可配置 index.html 强缓存 60s 时间
  • 高阶: 基于 docker 学习 nginx 配置，并可配置 gzip/brotli
  • 面试: brotli/gzip 有何区别

参考资料

[1]

simple-deploy:https://github.com/shfshanyue/simple-deploy/tree/master/learn-nginx

[2]

shfshanyue/whoami:https://github.com/shfshanyue/whoami

[3]

shfshanyue/simple-daploy:learn-nginxs:https://github.com/shfshanyue/simple-deploy/blob/master/learn-nginx/location2.conf

nginx http 容器镜像服务 https api

0 人点赞