从零手写实现 nginx-29-try_files 指令

莱莱 · 2024-7-16 22:36:43

前言

大家好，我是老马。很高兴碰到你。
我们为 java 开辟者实现了 java 版本的 nginx

https://github.com/houbb/nginx4j

假如你想知道 servlet 如那边置惩罚的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

try_files file1 [file2 ... filen] uri|=code;

复制代码

file1, file2, ... filen: 依次检查这些文件或目录的存在性。
uri: 假如前面的文件或目录都不存在，重定向到指定的 URI。
=code: 假如前面的文件或目录都不存在，返回指定的 HTTP 状态码。

示例

静态文件服务

优先返回静态文件，假如文件不存在，则返回 404 错误。

server {
listen 80;
server_name example.com;
location / {
root /var/www/html;
try_files $uri $uri/ =404;
}
}

复制代码

动态内容处置惩罚

优先返回静态文件，假如文件不存在，则将请求重定向到一个 PHP 处置惩罚程序。

server {
listen 80;
server_name example.com;
location / {
root /var/www/html;
try_files $uri $uri/ /index.php?$query_string;
}
location ~ \.php$ {
root /var/www/html;
fastcgi_pass unix:/run/php/php7.4-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
}
}

复制代码

单页应用（SPA）

所有路径都指向入口的 index.html 文件，以支持前端路由。

server {
listen 80;
server_name example.com;
location / {
root /var/www/html;
try_files $uri $uri/ /index.html;
}
}

复制代码

工作原理

尝试多个文件路径：按顺序检查指定的文件或目录是否存在。假如找到一个存在的文件或目录，则立刻返回该文件或目录。
重定向到 URI：假如所有指定的文件或目录都不存在，则重定向到一个指定的 URI。这通常用于将请求传递给动态处置惩罚程序。
返回指定的 HTTP 状态码：假如所有指定的文件或目录都不存在，并且未指定 URI，则返回指定的 HTTP 状态码（如 404）。

长处

机动性高：可以轻松处置惩罚静态文件、动态内容和错误处置惩罚。
配置简便：通过一条指令即可实现多种路径检查和处置惩罚逻辑。
性能优化：优先处置惩罚静态文件，避免不须要的动态处置惩罚，提高响应速度。

缺点

调试困难：由于会依次检查多个路径，调试和排盘问题时大概比较复杂。
机动性有限：无法进行条件判断或复杂的重写规则处置惩罚，需要结合其他指令使用。
错误处置惩罚简单：只能指定简单的错误处置惩罚方式，无法进行复杂的错误处置惩罚逻辑。

总结

Nginx 的 try_files 指令是一种非常强大和机动的工具，适用于处置惩罚多种请求路径和文件检查需求。
通过适当的配置，可以显著提高服务器的性能和响应速度，同时简化配置文件的编写和维护。
java 实现

整体思路

1）遍历非末了一个的 uri，替换占位符，判断文件是否存在，存在则返回。
2）判断末了一个 uri 大概 code，直接处置惩罚对应的逻辑。
焦点逻辑

/**
* try_files path1 path2 ... final;
*
* - `path1`, `path2`, ...：要检查的文件或 URI 列表。可以是相对路径或绝对路径。
*
* - `final`：如果前面的所有路径都不存在，最后一个参数可以是一个 URI，Nginx 将内部重定向到该 URI，或者是一个 HTTP 状态码（如 404），用于返回相应的错误。
*
* @see INginxPlaceholder 占位符
* @see com.github.houbb.nginx4j.support.request.dispatch.http.NginxRequestDispatchHttpReturn 设置对应的返回码 =xxx
*/
public class NginxTryFilesDefault implements INginxTryFiles{
private static final Log log = LogFactory.getLog(NginxTryFilesDefault.class);
/**
* 处理 try_files 指令
*
* @param request 请求
* @param nginxConfig 配置
* @param context 上下文
*/
public void tryFiles(FullHttpRequest request,
final NginxConfig nginxConfig,
NginxRequestDispatchContext context) {
// 获取当前的 location
List<NginxCommonConfigEntry> directiveList = InnerNginxContextUtil.getLocationDirectives(context);
Map<String, List<NginxCommonConfigEntry>> directiveMap = InnerNginxContextUtil.getLocationDirectiveMap(directiveList);
List<NginxCommonConfigEntry> tryFiles = directiveMap.get(NginxDirectiveEnum.TRY_FILES.getCode());
if(CollectionUtil.isEmpty(tryFiles)) {
return;
}
NginxCommonConfigEntry firstEntry = tryFiles.get(0);
// 遍历非 final 的文件信息
String notFinalUri = getNotFinalMatchedFileUri(firstEntry, context);
if(StringUtil.isNotEmpty(notFinalUri)) {
request.setUri(notFinalUri);
return;
}
// 判断 final 变量
final String lastUri = firstEntry.getValues().get(firstEntry.getValues().size()-1);
if(lastUri.startsWith("=")) {
// 拆分为 return
NginxReturnResult result = new NginxReturnResult();
result.setCode(Integer.parseInt(lastUri.substring(1)));
result.setValue("try_files final");
context.setNginxReturnResult(result);
return;
}
String lastReplaceUri = replacePlaceholders(lastUri, context.getPlaceholderMap());
request.setUri(lastReplaceUri);
}
/**
* 获取匹配的文件 url
* @param entry 实体
* @param context 上下文
* @return 结果
*/
private String getNotFinalMatchedFileUri(final NginxCommonConfigEntry entry,
NginxRequestDispatchContext context) {
List<String> values = entry.getValues();
for(int i = 0; i < values.size()-1; i++) {
String replacedUri = getMatchedFileUri(values.get(i), context);
if(StringUtil.isNotEmpty(replacedUri)) {
return replacedUri;
}
}
return null;
}
private String getMatchedFileUri(final String requestUri,
NginxRequestDispatchContext context) {
final Map<String, Object> replaceMap = context.getPlaceholderMap();
String replacedUri = replacePlaceholders(requestUri, replaceMap);
// 判断文件是否存
File file = InnerFileUtil.getTargetFile(replacedUri, context);
if(file.exists()) {
log.info("Nginx getMatchedFileUri file={}", file.getAbsolutePath());
return replacedUri;
}
return null;
}
/**
* 替换字符串中的占位符
*
* @param input 用户输入的字符串，包含占位符
* @param variables 存储占位符及其替换值的 Map
* @return 替换后的字符串
*/
public static String replacePlaceholders(String input, Map<String, Object> variables) {
// 使用 StringBuilder 来构建替换后的字符串
StringBuilder result = new StringBuilder(input);
// 遍历 Map 进行替换
for (Map.Entry<String, Object> entry : variables.entrySet()) {
String placeholder = entry.getKey();
String replacement = String.valueOf(entry.getValue());
// 使用 String 的 replace 方法替换所有占位符
int start = result.indexOf(placeholder);
while (start != -1) {
result.replace(start, start + placeholder.length(), replacement);
start = result.indexOf(placeholder, start + replacement.length());
}
}
return result.toString();
}
}

复制代码

小结

Nginx 的 try_files 指令是一个强大且机动的工具，用于处置惩罚静态文件、友好 URL 重写和自定义错误处置惩罚。
它通过按顺序检查多个路径并实验相应操纵，使配置文件更加简便和高效。
主要用途

静态文件服务：首先尝试提供静态文件，假如找不到则实验其他操纵。
友好 URL 重写：用于支持伪静态 URL，将请求重写到实际的文件路径或动态脚本。
错误处置惩罚：假如所有尝试的文件都不存在，则返回一个特定的错误页面。

工作机制

try_files 按顺序检查列出的每个路径。
假如找到了一个存在的文件或目录，则立刻停止进一步检查并使用该文件或目录响应请求。
假如所有列出的路径都不存在，则实验末了指定的 URI，这通常是一个错误页面或其他处置惩罚逻辑。

长处

高效静态文件处置惩罚：减少了不须要的动态请求处置惩罚。
机动的错误处置惩罚：可以轻松配置自定义错误页面或重写规则。
简便配置：使复杂的文件查找和重写逻辑更加直观和易于管理。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

		自动登录	找回密码
密码			立即注册

从零手写实现 nginx-29-try_files 指令

0 个回复

快速回复

楼主热帖

标签云