前言

大家好，我是老马。很高兴遇到你。

我们为 java 开发者实现了 java 版本的 nginx

https://github.com/houbb/nginx4j

如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

手写从零实现简易版 tomcat minicat

手写 nginx 系列

如果你对 nginx 原理感兴趣，可以阅读：

从零手写实现 nginx-01-为什么不能有 java 版本的 nginx?

从零手写实现 nginx-02-nginx 的核心能力

从零手写实现 nginx-03-nginx 基于 Netty 实现

从零手写实现 nginx-04-基于 netty http 出入参优化处理

从零手写实现 nginx-05-MIME类型（Multipurpose Internet Mail Extensions，多用途互联网邮件扩展类型）

从零手写实现 nginx-06-文件夹自动索引

从零手写实现 nginx-07-大文件下载

从零手写实现 nginx-08-范围查询

从零手写实现 nginx-09-文件压缩

从零手写实现 nginx-10-sendfile 零拷贝

从零手写实现 nginx-11-file+range 合并

从零手写实现 nginx-12-keep-alive 连接复用

从零手写实现 nginx-13-nginx.conf 配置文件介绍

从零手写实现 nginx-14-nginx.conf 和 hocon 格式有关系吗？

从零手写实现 nginx-15-nginx.conf 如何通过 java 解析处理？

从零手写实现 nginx-16-nginx 支持配置多个 server

从零手写实现 nginx-17-nginx 默认配置优化

从零手写实现 nginx-18-nginx 请求头+响应头操作

从零手写实现 nginx-19-nginx cors

从零手写实现 nginx-20-nginx 占位符 placeholder

从零手写实现 nginx-21-nginx modules 模块信息概览

从零手写实现 nginx-22-nginx modules 分模块加载优化

从零手写实现 nginx-23-nginx cookie 的操作处理

从零手写实现 nginx-24-nginx IF 指令

从零手写实现 nginx-25-nginx map 指令

从零手写实现 nginx-26-nginx rewrite 指令

从零手写实现 nginx-27-nginx return 指令

从零手写实现 nginx-28-nginx error_pages 指令

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

nginx 的 return 指令

nginx 的 return 指令

return 指令是 Nginx 中用于返回特定 HTTP 状态码和可选内容的指令。

它通常用于快速响应，控制访问和重定向等场景。

基本语法

return code [text];

• code：要返回的 HTTP 状态码，例如 200、301、404 等。

• text（可选）：要返回的内容，通常是一个简单的字符串或重定向 URL。

用法示例

1. 返回状态码

   返回一个简单的状态码，例如 404：

   location /example {
       return 404;
   }
   

2. 返回状态码和内容

   返回状态码 200 和一段文本：

   location /hello {
       return 200 "Hello, World!";
   }
   

3. 重定向

   返回一个重定向（301）到另一个 URL：

   location /old {
       return 301 https://example.com/new;
   }
   

4. 根据条件返回

   在某些情况下，可以根据特定条件返回不同的状态码：

   location /check {
       if ($arg_user = "admin") {
           return 200 "Welcome, Admin!";
       }
       return 403 "Access Denied";
   }
   

注意事项

• return 指令是一个较为简单的指令，适合处理简单的响应。对于更复杂的逻辑，可能需要使用 rewrite 或其他 Nginx 指令。
• 使用 return 指令会立即结束请求处理，因此不会执行后续的指令或访问控制模块。

常见场景

• 防止访问特定路径：可以用 return 403; 拒绝对某些路径的访问。
• 旧版 URL 重定向：通过返回 301 状态码，将用户重定向到新版本 URL。
• 自定义错误页面：可以通过返回特定状态码和内容来提供自定义错误响应。

java+netty 实现 return

    /**
     * @since 0.24.0
     * @param request 请求
     * @param context 上下文
     * @return
     */
    protected FullHttpResponse buildHttpResponseForReturn(FullHttpRequest request,
                                                   NginxRequestDispatchContext context) {
        logger.info("[Nginx] NginxRequestDispatchReturn request for http={}", request);

        final NginxReturnResult nginxReturnResult = context.getNginxReturnResult();
        HttpResponseStatus responseStatus = HttpResponseStatus.valueOf(nginxReturnResult.getCode(),
                nginxReturnResult.getValue());
        FullHttpResponse response = InnerRespUtil.buildCommonResp(null, responseStatus, request);

        //301
        if(301 == nginxReturnResult.getCode()) {
            response.headers().set(HttpHeaderNames.LOCATION, nginxReturnResult.getValue());
        }

        //TODO: 还有许多，是不是需要特殊处理？
        return response;
    }