写给前端的nginx配置指南基于docker所有配置秒级运行(最新讲解)

目录

通过 docker 高效学习 nginx 配置root 与 indexlocation

location 修饰符验证location 优先级验证



proxy_passadd_header


CacheCORSHSTSCSP



作业

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

nginx 的重要性不言而喻。

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

通过 docker 高效学习 nginx 配置

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

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

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

1. version: “3”
2. services:
3.   # 关于 nginx 最常见配置的学习
4.   nginx:
5.     image: nginx:alpine
6.     ports:
7.       – 8080:80
8.     volumes:
9.       – ./nginx.conf:/etc/nginx/conf.d/default.conf
10.       – .:/usr/share/nginx/html
11.   # 关于 location 的学习
12.   location: …
13.   # 关于 location 匹配顺序的学习
14.   order1: …

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

1. $ docker-compose up <service>
2. # 学习 nginx 最基础的配置
3. $ docker-compose up nginx
4. # 学习关于 location 的配置
5. $ docker-compose up location

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

root 与 index

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

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

1. server {
2.     listen       80;
3.     server_name  localhost;
4.     root   /usr/share/nginx/html;
5.     index  index.html index.htm;
6. }

复制代码
location

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

1. location [ = | ~ | ~* | ^~ ] uri { … }

复制代码 其中 uri 前可提供以下修饰符

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

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

1. add_header X-Config B;

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

location 修饰符验证

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

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

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

1. $ docker-compose up location2 api

复制代码 以下是关于验证 location 的配置文件，详见 shfshanyue/simple-daploy:learn-nginxs

1. server {
2.     listen       80;
3.     server_name  localhost;
4.     root   /usr/share/nginx/html;
5.     index  index.html index.htm;
6.     # 通用匹配，所有 /xxx 任意路径都会匹配其中的规则
7.     location / {
8.         add_header X-Config A;
9.         try_files  $uri $uri.html $uri/index.html /index.html;
10.     }
11.     # http://localhost:8120/test1           ok
12.     # http://localhost:8120/test1/          ok
13.     # http://localhost:8120/test18          ok
14.     # http://localhost:8120/test28          not ok
15.     location /test1 {
16.         # 可通过查看响应头来判断是否成功返回
17.         add_header X-Config B;
18.         proxy_pass http://api:3000;
19.     }
20.     # http://localhost:8120/test2           ok
21.     # http://localhost:8120/test2/          not ok
22.     # http://localhost:8120/test28          not ok
23.     location = /test2 {
24.         add_header X-Config C;
25.         proxy_pass http://api:3000;
26.     }
27.     # http://localhost:8120/test3           ok
28.     # http://localhost:8120/test3/          ok
29.     # http://localhost:8120/test38          ok
30.     # http://localhost:8120/hellotest3      ok
31.     location ~ .*test3.* {
32.         add_header X-Config D;
33.         proxy_pass http://api:3000;
34.     }
35.     # http://localhost:8120/test4           ok
36.     # http://localhost:8120/test4/          ok
37.     # http://localhost:8120/test48          ok
38.     # http://localhost:8120/test28          not ok
39.     location ^~ /test4 {
40.         # 可通过查看响应头来判断是否成功返回
41.         add_header X-Config E;
42.         proxy_pass http://api:3000;
43.     }
44. }

复制代码
location 优先级验证

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

配置如下:

1. # 以下配置，访问以下链接，其 X-Config 为多少
2. #
3. # http://localhost:8210/shanyue，为 B，若都是前缀匹配，则找到最长匹配的 location
4. server {
5.     root   /usr/share/nginx/html;
6.     # 主要是为了 shanyue 该路径，因为没有后缀名，无法确认其 content-type，会自动下载
7.     # 因此这里采用 text/plain，则不会自动下载
8.     default_type text/plain;
9.     location ^~ /shan {
10.         add_header X-Config A;
11.     }
12.     location ^~ /shanyue {
13.         add_header X-Config B;
14.     }
15. }

复制代码 启动服务:

1. $ docker-compose up order1

复制代码 curl 验证:

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

1. # 查看其 X-Config 为 B
2. $ curl –head http://localhost:8210/shanyue
3. HTTP/1.1 200 OK
4. Server: nginx/1.21.4
5. Date: Fri, 03 Jun 2022 10:15:11 GMT
6. Content-Type: text/plain
7. Content-Length: 15
8. Last-Modified: Thu, 02 Jun 2022 12:44:23 GMT
9. Connection: keep-alive
10. ETag: “6298b0a7-f”
11. X-Config: B
12. Accept-Ranges: bytes

复制代码
proxy_pass

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

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

X服务器地址不含 URI，则此时客户端请求路径与X服务器路径相同。
强烈建议这种方式X服务器地址含 URI，则此时客户端请求路径匹配 location，并将其 location 后的路径附在X服务器地址后。

1. # 不含 URI
2. proxy_pass http://api:3000;
3. # 含 URI
4. proxy_pass http://api:3000/;
5. proxy_pass http://api:3000/api;
6. proxy_pass http://api:3000/api/;

复制代码 再举一个例子:

访问 http://localhost:8300/api3/hello，与以下路径匹配成功proxy_pass 附有 URI匹配路径后多余的路径为 /hello，将其附在 proxy_pass 之后，得 http://api:3000/hello/hello

1. location /api3 {
2.     add_header X-Config C;
3.     # http://localhost:8300/api3/hello -> proxy:3000/hello/hello
4.     proxy_pass http://api:3000/hello;
5. }

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

1. $ docker-compose up proxy api

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

1. server {
2.     listen       80;
3.     server_name  localhost;
4.     root   /usr/share/nginx/html;
5.     index  index.html index.htm;
6.     # 建议使用此种 proxy_pass 不加 URI 的写法，原样路径即可
7.     # http://localhost:8300/api1/hello -> proxy:3000/api1/hello
8.     location /api1 {
9.         # 可通过查看响应头来判断是否成功返回
10.         add_header X-Config A;
11.         proxy_pass http://api:3000;
12.     }
13.     # http://localhost:8300/api2/hello -> proxy:3000/hello
14.     location /api2/ {
15.         add_header X-Config B;
16.         proxy_pass http://api:3000/;
17.     }
18.     # http://localhost:8300/api3/hello -> proxy:3000/hello/hello
19.     location /api3 {
20.         add_header X-Config C;
21.         proxy_pass http://api:3000/hello;
22.     }
23.     # http://localhost:8300/api4/hello -> proxy:3000//hello
24.     location /api4 {
25.         add_header X-Config D;
26.         proxy_pass http://api:3000/;
27.     }
28. }

复制代码
add_header

控制响应头。

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

CacheCORSHSTSCSP…

Cache

1. location /static {
2.     add_header Cache-Control max-age=31536000;
3. }

复制代码
CORS

1. location /api {
2.     add_header Access-Control-Allow-Origin *;
3. }
4. 复制代码

复制代码
HSTS

1. location / {
2.     listen 443 ssl;
3.     add_header Strict-Transport-Security max-age=7200;
4. }

复制代码
CSP

1. location / {
2.     add_header Content-Security-Policy “default-src ‘self’;”;
3. }

复制代码
作业

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

到此这篇关于写给前端的nginx配置指南基于docker所有配置秒级运行的文章就介绍到这了,更多相关docker  nginx 配置内容请搜索软件技术网以前的文章或继续浏览下面的相关文章希望大家以后多多支持软件技术网！