Spring Boot 获取 HttpServletRequest 的方法

本文介绍 Spring Boot 2 获取 HttpServletRequest 的方法。

目录

  • 概述
  • 方法
    • Controller 方法参数
    • 属性自动注入
    • 手动方法调用
    • 借助 @ModelAttribute 注解
  • 总结

概述

借助 Spring MVC 开发 Web 应用的过程中经常需要使用 HttpServletRequest 对象获取 HTTP 请求相关的信息，如：客户端 IP、HTTP Header 中的属性等。
使用 HttpServletRequest 对象的场景大体分为两类：

  • 在 Spring 注入的 Bean 中使用；
  • 在非 Spring 注入的 Bean 中使用，如普通的 Java 对象或类的静态方法。

方法

Controller 方法参数

原理：
在 Controller 方法开始处理请求时，Spring 会将 HttpServletRequest 对象自动赋值到方法参数中。除 HttpServletRequest 对象外，还有很多其它参数可以通过此方法获取，参考：https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-methods

代码示例：

@GetMapping("/method1")
public String method1(HttpServletRequest request) {
    System.out.println("Request URI: " + request.getRequestURI());
    return "Invoke HttpServletRequest by method param.";
}

线程安全性分析：
HttpServletRequest 对象作为方法参数，相当于局部变量，是 线程安全 的。

缺点：

  • 代码冗余，每个 Controller 方法中都要有 HttpServletRequest request 参数；
  • HttpServletRequest 对象的获取必须从 Controller 开始，如果使用 HttpServletRequest 对象的地方在函数调用层级比较深的地方，那么整个函数调用链上的所有方法都要有 HttpServletRequest request 参数。实际上在请求处理的全过程中，HttpServletRequest 对象始终存在，相当于线程内部的一个全局变量。
属性自动注入

代码示例：

@Autowired
private HttpServletRequest autowiredRequest;

@GetMapping("/method2")
public String method2() {
    System.out.println("Request URI: " + autowiredRequest.getRequestURI());
    return "Invoke HttpServletRequest by @Autowired.";
}

线程安全性分析：
使用 @Autowired 注解时，Spring 实际注入的并非 HttpServletRequest 对象，而是一个代理 proxy（代理实现参考 AutowireUtils.ObjectFactoryDelegatingInvocationHandler），当方法中需要使用 HttpServletRequest 对象时通过此代理获取，所以虽然 Controller 是个单例类，但通过此方法使用 HttpServletRequest 对象是 线程安全 的。

优点：

  • 不局限于 Controller 中，可以在通过 @Component、@Service、@Repository 注解注入的其它 Bean 中使用；
  • 注入的对象不局限于 HttpServletRequest 对象，还可以注入其它 scope 为 request 或 session 的对象，如 HttpServletResponse、HttpSession 等，并保证线程安全；
  • 相比于【Controller 方法参数】方法，减少了代码冗余，只需要在需要使用 HttpServletRequest 对象的方法所属 Bean 中注入。

缺点：

  • 如果存在很多 Bean 需要使用 HttpServletRequest 对象，则每个 Bean 都要维护一个使用 @Autowired 注解注入的 HttpServletRequest request 属性，也存在一定代码冗余，可以定义一个公共父类维护这些自动注入的属性，但是继承本身也存在一定问题。
手动方法调用

代码示例：

@GetMapping("/method3")
public String method3() {
    HttpServletRequest request =
            ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest();
    System.out.println("Request URI: " + request.getRequestURI());
    return "Invoke HttpServletRequest by ServletRequestAttributes.";
}

线程安全性分析：
与【属性自动注入】线程安全性分析一致，属于 线程安全。

优点：

  • 可以在非 Spring 注入的 Bean 中使用，如普通 Java 对象或静态方法。

缺点：

  • 代码比较繁琐。
借助 @ModelAttribute 注解

代码示例：

@Autowired
private HttpServletRequest bindRequest;

@ModelAttribute
public void bindRequest(HttpServletRequest request) {
    this.bindRequest = request;
}

@GetMapping("/method4")
public String method4() {
    System.out.println("Request URI: " + bindRequest.getRequestURI());
    return "Invoke HttpServletRequest by @ModelAttribute.";
}

线程安全性分析：
@ModelAttribute 注解修饰 Controller 方法时，作用是在 Controller 中每个处理请求的方法执行前执行，而 Controller 是单例，所以当同时处理多个请求时 HttpServletRequest 对象属性可能会被覆盖，所以是 线程不安全 的！

总结

全量代码：

package tutorial.spring.boot.mvc.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@RestController
public class DemoController {

    @Autowired
    private HttpServletRequest autowiredRequest;

    @Autowired
    private HttpServletRequest bindRequest;

    @GetMapping("/method1")
    public String method1(HttpServletRequest request) {
        System.out.println("Request URI: " + request.getRequestURI());
        return "Invoke HttpServletRequest by method param.";
    }

    @GetMapping("/method2")
    public String method2() {
        System.out.println("Request URI: " + autowiredRequest.getRequestURI());
        return "Invoke HttpServletRequest by @Autowired.";
    }

    @GetMapping("/method3")
    public String method3() {
        HttpServletRequest request =
                ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest();
        System.out.println("Request URI: " + request.getRequestURI());
        return "Invoke HttpServletRequest by ServletRequestAttributes.";
    }

    @ModelAttribute
    public void bindRequest(HttpServletRequest request) {
        this.bindRequest = request;
    }

    @GetMapping("/method4")
    public String method4() {
        System.out.println("Request URI: " + bindRequest.getRequestURI());
        return "Invoke HttpServletRequest by @ModelAttribute.";
    }
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,736评论 4赞 362
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,167评论 1赞 291
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,442评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,902评论 0赞 204
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,302评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,573评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,847评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,562评论 0赞 197
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,260评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2赞 245
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,367评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,016评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2赞 274
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2赞 269