在 Windows 中简化 Nginx 命令行操作

本文的主要目的是为了实现打开命令行后可以直接运行 Nginx 的常用命令，不需要手动切换到工作目录，从而简化操作流程。

1. 背景

在 Windows 中运行 Nginx 每次都需要进入安装目录，运行 Nginx 工具：

  • 直接将 Nginx 的安装目录添加到「Windows 系统环境变量 > Path」中后，只能运行 nginx -v 命令。而 nginx -t 或者 start nginx 命令则无法正常执行。
  • 直接将 start Nginx 封装成快捷方式，则只能用于启动 Nginx，如果要运行其他 reload 等命令需要单独封装，仍然非常麻烦。

2. 使用批处理脚本自动切换目录

创建一个自动将工作目录定位到 Nginx 目录的脚本，以 bat 脚本为例（请根据自己的 Nginx 目录修改 targetDir 的值）：

1
2
3
4
5
6
7
8
9
@echo off

REM 设置目标目录
set "targetDir=T:\zeoapp\nginx\nginx-1.26.2"

REM 切换目录
cd /d "%targetDir%"

cmd /k
  • @echo off关闭命令回显。
  • /K: 表示在执行完指定的命令后保持打开状态（不退出）

2.1. 扩展

1
2
3
4
5
6
# 检查 nginx 进程运行情况
# imagename 进程的映像名称（进程所基于的可执行文件的名字）
tasklist /fi "imagename eq nginx.exe"
# 强制关闭 nginx 进程
# /F 表示强制 /IM 进程的映像名称
taskkill /F /IM nginx.exe

3. 方法二：创建一个映射 Nginx 主要方法的脚本

  1. 在 Nginx 目录下，创建一个脚本文件；
  2. 在脚本文件中实现，映射 Nginx 的主要参数或方法，脚本文件参考见下文；
  3. 将脚本文件所在目录添加到系统环境变量 Path 中。

此方法更详细的步骤可以参考：
Windows下配置Nginx环境变量，无需在Nginx文件下启动
windows 配置nginx环境变量（玩出新花样）（nginx下载与安装）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# 源于 https://www.cnblogs.com/Marydon20170307/p/15944960.html
# 详细步骤请参考如下文章：
# https://www.cnblogs.com/Marydon20170307/p/15944960.html
# https://jnssd.com/2023/01/17/operation/Windows%E4%B8%8B%E9%85%8D%E7%BD%AENginx%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%EF%BC%8C%E6%97%A0%E9%9C%80%E5%9C%A8Nginx%E6%96%87%E4%BB%B6%E4%B8%8B%E5%90%AF%E5%8A%A8/
@echo off
if "%1"=="-?" goto help
if "%1"=="-h" goto help
if "%1"=="-v" goto vVtTqspecg
if "%1"=="-V" goto vVtTqspecg
if "%1"=="-t" goto vVtTqspecg
if "%1"=="-T" goto vVtTqspecg
if "%1"=="-q" goto vVtTqspecg
if "%1"=="-s" goto vVtTqspecg
if "%1"=="-p" goto vVtTqspecg
if "%1"=="-e" goto vVtTqspecg
if "%1"=="-c" goto vVtTqspecg
if "%1"=="-g" goto vVtTqspecg
if "%1"=="start" goto start
if "%1"=="search" goto search
if "%1"=="kill" goto kill
goto errors
 
:help
nginx -v
echo Usage: nginx2 [-?,-h] [-v] [-V] [-t] [-T] [-q]
echo               [-s signal] [-p prefix] [-e filename] [-c filename] [-g directives]
echo               [start] [search] [kill]
echo=
echo Options:
echo   -?,-h           : this help
echo   -v              : show version and exit
echo   -V              : show version and configure options then exit
echo   -t              : test configuration and exit
echo   -T              : test configuration, dump it and exit
echo   -q              : suppress non-error messages during configuration testing
echo   -s signal       : send signal to a master process: stop, quit, reopen, reload
echo   -p prefix       : set prefix path (default: NONE)
echo   -e filename     : set error log file (default: logs/error.log)
echo   -c filename     : set configuration file (default: conf/nginx.conf)
echo   -g directives   : set global directives out of configuration file
echo   start           : start nginx master process(customize include)
echo   search          : show the nginx master process list(customize include)
echo   kill            : kill all nginx master processes(customize include)
echo=
exit /B
 
:vVtTqspecg
nginx %1 %2 -p %NGINX_HOME%
exit /B
 
:start
start nginx -p %NGINX_HOME%
exit /B
 
:search
tasklist /fi "imagename eq nginx.exe"
exit /B
 
:kill
taskkill /F /IM nginx.exe
exit /B
 
:errors
echo nginx2: invalid option: "%1 %2"
echo=   
exit /B

3.1. 参考

  1. windows 配置nginx环境变量（玩出新花样）（nginx下载与安装）- Marydon - 博客园: https://www.cnblogs.com/Marydon20170307/p/15944960.html
  2. Windows下配置Nginx环境变量，无需在Nginx文件下启动 | 个人随身录: https://jnssd.com/2023/01/17/operation/Windows%E4%B8%8B%E9%85%8D%E7%BD%AENginx%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%EF%BC%8C%E6%97%A0%E9%9C%80%E5%9C%A8Nginx%E6%96%87%E4%BB%B6%E4%B8%8B%E5%90%AF%E5%8A%A8/
在 Windows 中简化 Nginx 命令行操作
https://blog.cc01cc.cn/2024/10/30/nginx-windows-simplify/
作者
零一/cc01cc(zeo)
发布于
2024年10月30日
许可协议