From 745bd5d0245077b4ab4d01aaf24aba8f8061a58a Mon Sep 17 00:00:00 2001 From: Zhang Peng Date: Thu, 5 Jul 2018 10:09:27 +0800 Subject: [PATCH] :memo: Writing docs. --- README.md | 4 ++ demos/README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+) create mode 100644 demos/README.md diff --git a/README.md b/README.md index ffa8de9..7d60bf3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Nginx +> 本项目是一个 Nginx 极简教程，目的在于帮助新手快速入门 Nginx。 +> +> [demos](demos) 目录中的示例模拟了工作中的一些常用实战场景，并且都可以通过脚本一键式启动，让您可以快速看到演示效果。 + - [概述](#概述) diff --git a/demos/README.md b/demos/README.md new file mode 100644 index 0000000..c5b1c6b --- /dev/null +++ b/demos/README.md @@ -0,0 +1,119 @@ +# Nginx 示例教程 + +## 教程说明 + +### 环境要求 + +- Maven +- JDK8 +- Nginx-1.14.0（内置） + +### javaapp + +我写了一个嵌入式 Tomcat 的 Java 服务，代码在 javaapp 目录，基于 maven 管理。这个服务可以通过在启动时指定 `-Dtomcat.connector.port` 和 `-Dtomcat.context.path` 来分别指定服务启动时的端口号和 context。这样可以很方便的模拟多个服务器的场景。 + +例如： + +``` +java -Dtomcat.connector.port=9030 -Dtomcat.context.path=/app -cp "JavaWebApp/WEB-INF/classes;JavaWebApp/WEB-INF/lib/*" io.github.dunwu.app.Main +``` + +- `io.github.dunwu.app.Main` 是这个 Java 服务的启动类。 +- `JavaWebApp/WEB-INF/classes;JavaWebApp/WEB-INF/lib/*` 是 class 路径和 lib 路径，必须指定，否则无法识别启动类。 + +如上的配置参数，可以启动一个端口号为 9030，上下文为 `/app` 的服务。访问路径为：http://localhost:9030/app。 + +### nginx-1.14.0 + +nginx-1.14.0 是 Nginx 的 windows 环境的 1.14.0 官方版本。之所以把它完整的放入本项目中也是为了方便演示。 + +我添加了两个 bat 脚本，可以启动和关闭 nginx 服务。 + +- [nginx-start.bat](nginx-1.14.0/nginx-start.bat) +- [nginx-stop.bat](nginx-1.14.0/nginx-stop.bat) + +在 Nginx 默认配置文件 [nginx.conf](nginx-1.14.0/conf/nginx.conf) 中我通过配置 `include demos/*.conf;` 将 [Nginx/demos/nginx-1.14.0/conf/demos](nginx-1.14.0/conf/demos) 目录中所有 Nginx 配置示例都引入。 + +### scripts + +`scripts` 中包含了运行示例的启动脚本。目前只支持 windows 下运行，当然想基于此教程改造为在 Linux 下运行也不难，将 nginx-1.14.0 替换为 Linux 版本，bat 脚本修改为 shell 即可。 + +运行步骤： + +1. 首先必须执行 [build-javaapp.bat](scripts/build-javaapp.bat) 构建 javaapp +2. 想运行哪个 demo，就执行对应的 demoxx-start.bat 脚本。 + +### 添加 hosts + +因为示例中使用的不是公网域名，域名服务器不能识别。所以，要演示示例，还需要修改本地 hosts。 + +- windows 的 host 路径一般在：`C:\Windows\System32\drivers\etc\hosts` +- linxu 的 host 路径一般在：`/etc/hosts` + +## 示例说明 + +### Demo01 - 简单的反向代理示例 + +本示例启动一个 JavaApp，访问地址为：localhost:9010。 +在 Nginx 中配置它的反向代理 host 为 www.demo01.com。Nginx 配置文件：[demo01.conf](nginx-1.14.0/conf/demos/demo01.conf) + +运行步骤： + +1. 执行 [demo01-start.bat](scripts/demo01-start.bat) 脚本。 +2. 配置 hosts：`127.0.0.1 www.demo01.com` +3. 在浏览器中访问：www.demo01.com + +
+ +
+ +### Demo02 - 负载均衡示例 + +本示例启动三个 JavaApp，访问地址分别为： + +- localhost:9021 +- localhost:9022 +- localhost:9023 + +在 Nginx 中统一配置它们的反向代理 host 为 www.demo02.com，并设置相应权重，以便做负载均衡。Nginx 配置文件：[demo02.conf](nginx-1.14.0/conf/demos/demo02.conf) + +运行步骤： + +1. 执行 [demo02-start.bat](scripts/demo02-start.bat) 脚本。 +2. 配置 hosts：`127.0.0.1 www.demo02.com` +3. 在浏览器中访问：www.demo02.com + +如图所示：三次访问的端口号各不相同，说明三个服务器各自均有不同机率（基于权重）被访问。 + +
+ +
+ +### Demo03 - 多 webapp 示例 + +当一个网站功能越来越丰富时，往往需要将一些功能相对独立的模块剥离出来，独立维护。这样的话，通常，会有多个 webapp。 + +http 的默认端口号是 80，如果在一台服务器上同时启动这 3 个 webapp 应用，都用 80 端口，肯定是不成的。所以，这三个应用需要分别绑定不同的端口号。 + +本示例启动三个 JavaApp，访问地址分别为： + +- localhost:9030/ +- localhost:9031/product +- localhost:9032/user + +Nginx 中的配置要点就是为每个 server 配置一个 upstream。并在 server 配置下的 location 中指定 context 对应的 upstream。 + +Nginx 配置文件：[demo03.conf](nginx-1.14.0/conf/demos/demo03.conf) + +运行步骤： + +1. 执行 [demo02-start.bat](scripts/demo03-start.bat) 脚本。 +2. 配置 hosts：`127.0.0.1 www.demo03.com` +3. 在浏览器中访问：www.demo03.com + +如图所示：三次访问的 context 各不相同。 + +
+ +
+