SpringMVC——6.常用注解

最新推荐文章于 2023-03-28 16:34:38 发布
最新推荐文章于 2023-03-28 16:34:38 发布
阅读量132 收藏
点赞数
分类专栏： 框架技术
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33905217/article/details/105819936
版权

1.获取原生ServletAPI

原生的Servelt通过HttpServletRequest为后台发送数据，通过HttpServletResponse获取处理后的数据

代码实践

1）网页部分

网页发起目标路径访问请求

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--获取servlet原生api-->
    <a href="hello5">获取servlet原生api</a>
</body>
</html>

2）处理器部分

@RequestMapping(path="/hello5")
    public String sayHello5(HttpServletRequest request, HttpServletResponse response){
        System.out.println("request:"+request);
        System.out.println("==========================");
        HttpSession session = request.getSession();
        System.out.println("session:"+session);
        System.out.println("==========================");
        ServletContext context = session.getServletContext();
        System.out.println("context:"+context);
        System.out.println("==========================");
        System.out.println("response:"+response);
        return "success";
    }

2.常用注解

2.1RequestParam

作用：把请求中指定名称的参数给控制器中的形参赋值

属性：

  • value/name：请求中的参数名
  • required：请求中是否必须提供此参数，默认为true，不提供则报错

示例

前面一开始我们提到的例子必须是前端name与形参名必须一致，但有时我们因为某些原因不会统一，这时需要用到requestParam注解

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@RequestParam-->
    <a href="hello6?name='哈哈'">@RequestParam传递</a>
</body>
</html>

2）控制器部分：

@RequestMapping(path="/hello6")
    public String sayHello6(@RequestParam(value = "name") String username){
        System.out.println(username);
        return "success";
    }

3）结果显示：

注意：从上述例子来看，前端传来的数据名为name，但是后台接收的形参名为username，通过@RequestParam我们可以将使两个不同名的值完成传值

2.2 RequestBody

作用：用于获取请求体内容，直接得到的是key=value&key=value...结构的数据(get请求方法不适用)
相当于直接将表单中的请求参数全部封装到一条字符串中。

什么时候用的到：我们请求中有个概念叫做异步，异步请求需要用到json数据格式

属性：

  • required：是否必须有请求体（默认为true，true时get请求会报错，flase则不报错但是为null）
    get的请求参数全部被封装到地址后，并没有请求体

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@RequestBody-->
    <form action="testRequestBody" method="post">
        姓名<input type="text" name="name"/><br/>
        年龄<input type="text" name="age" />
        <input type="submit" />
    </form>
</body>
</html>

2）控制器部分：

/**
    * @Description: 测试RequestBody
    * @Param: [body]
    * @return: java.lang.String
    * @Author: XHY
    * @Date: 2020/4/28
    */
    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody String body){
        System.out.println(body);
        return "success";
    }

3）结果显示：

2.3 PathVariable

作用：绑定URL中的占位符。例如url中有个/delete/{id} （url中出现占位符是rest风格URL）

属性：

  • value：指定url中的占位符名称
  • required：是否必须提供占位符

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@PathVariable-->
    <a href="testPathVariable/hehe/31">PathVariable1</a>
</body>
</html>

2）控制器部分：

/** 
    * @Description: 测试PathVariable
    * @Param: [name, age] 
    * @return: java.lang.String 
    * @Author: XHY
    * @Date: 2020/4/28
    */
    @RequestMapping("/testPathVariable/{name}/{age}")
    public String testPathVariable(@PathVariable("name") String name,@PathVariable("age") int age){
        System.out.println(name+"/"+age);
        return "success";
    }

3）结果显示：

2.3.1  REST风格URL

REST(representation State Transfer)(也被成为restful)

与原有请求方式不同，我们Springmvc通过为不同控制器类的不同方法设置不同的请求路径来区分我要向那个方法发起请求，但restful不同，它将所有请求方法设置为一样的请求路径，那么我们如何区分我该向那个方法发起请求呢，我们通过设置不同方法获取请求的方式如get/post/put以及请求路径后所带的占位符，通过请求方式与后者所跟占位符名的不同我们来区分要调用哪个处理器方法。
        再细致一些，比如我们有两个方法，一个有参数叫id，另一个无参，他们的请求方式相同但是我们通过requestPath/{id}与requestPath来区分我们要调用哪个方法。

优点：结构清晰、符合标准、易于理解、拓展方便、更利于缓存。

2.3.2 HiddentHttpMethodFilter

作用：由于浏览器表单只支持get/post请求，delete/put等并不支持，spring3.0增加了一个过滤器HiddentHttpMethodFilter，可以将浏览器请求方式更改为指定方式来发送给我们的控制器方法

使用方法：

  1. 在web.xml中配置该过滤器
  2. 该方式必须使用post请求
  3. 按照要求提供_method请求参数，该参数就是我们需要指定的请求方式

这中方式相对繁琐，暂未学习，而且后面可以通过类似webClient代替这样的请求修改方式。所以这里暂不做描述。

2.4 RequestHeader

作用：获取请求中的消息头

属性：

  • value：提供消息头名称
  • required：是否必须提供此消息头

注：实际开发中并不常用

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@RequestHeader-->
    <a href="testRequestHeader">RequestHeader</a>
</body>
</html>

2）控制器部分：

/** 
    * @Description: 测试RequestHeader
    * @Param: [accept] 
    * @return: java.lang.String 
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/testRequestHeader")
    public String testPathVariable(@RequestHeader("accept") String accept){
        System.out.println(accept);
        return "success";
    }

3）结果显示：

2.5 Cookie Value

作用：将指定cookie名称的值传入控制器参数

属性：

  • value：指定cookie名称
  • required：是否必须提供此cookie

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@RCookieValue-->
    <a href="testCookieValue">CookieValue</a>
</body>
</html>

2）控制器部分：

/** 
    * @Description: 
    * @Param: [cookieValue] 
    * @return: java.lang.String 
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/testCookieValue")
    public String testCookieValue(@CookieValue("JSESSIONID") String cookieValue){
        System.out.println(cookieValue);
        return "success";
    }

3）结果显示：

2.6 ModelAttribute

作用：用去修饰方法和参数

  • 出现在方法上表示此方法会在控制器方法执行前执行；
  • 出现在参数上表示获取指定的数据给参数赋值

属性：

  • value：用于获取数据的key

应用场景：当表单提交的数据不是完整的实体类数据时，保证没有提交的字段使用数据库对象原来的数据。
举例：当我有一个用户类，用户类有id、姓名、年龄三个属性，但我在前端页面上只写了id和name两个属性，传给处理器时，会默认被null。但是我们希望这个年龄可以根据我们输入的id与姓名去数据库中查询出来封装进去。所以我们可以通过@ModelAttribute在方法执行前直接通过id去调用进行填充并返回完整对象。

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@ModelAttribute-->
    <form action="testModelAttribute">
        姓名<input type="text" name="name"/><br/>
        <input type="submit" />
    </form>
</body>
</html>

2）控制器部分：

①有返回值写法

 /** 
    * @Description: 测试ModelAttribute
    * @Param: [user] 
    * @return: java.lang.String 
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(User user){
        System.out.println(user);
        return "success";
    }

    /** 
    * @Description: 
    * @Param: [name] 
    * @return: com.pojo.User 
    * @Author: XHY
    * @Date: 2020/4/29
    * @notice:形参的名字必须与前端页面提交的字段名一致，不能像处理器那样直接写个自定义对象，
    * 因为在处理器的形参中，核心控制器会为器注入对象，但是在ModelAttribute方法中并不会，如
    * 果你也写User user2这样的形参，那么这个ModelAttribute方法会由于参数对应不上而被跳过
    */
    @ModelAttribute
    public User completeUser(String name){
        User user = new User();
        user.setName(name);
        user.setAge(33);
        return user;
    }

② 无返回值写法

    /** 
    * @Description: 测试ModelAttribute
    * @Param: [user] 
    * @return: java.lang.String 
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user){
        System.out.println(user);
        return "success";
    }


    @ModelAttribute
    public void completeUser(String name, Map<String,User> map){
        User user = new User();
        user.setName(name);
        user.setAge(33);
        map.put("abc",user);
    }

3）结果显示：

2.7 SessionAttribute

作用：用于多次执行控制器方法间的参数共享（只能作用在类上）

属性：

  • value：用于指定存入的属性名称
  • type：用于指定存入的数据类型

注：我们原来如果需要在页面直接传递数据需要通过在request域中进行数据的存取来达到传递目标，但是这是一个原生的ServletAPI。如果使用它就会与Servelt产生过高的耦合度，也就是如果我们没有引入servlet的jar包我们甚至连编译都无法通过。因此这里引入了Model来解决这个问题（Model由于继承了LinkdeHashMap所以其实它本质上是一个map键值对集合），通过向model中添加键值对也就是向request域中添加数据。而我们如果需要在多个方法调用同一个参数那么需要这个参数在我们的session域中，我们的@SessionAttribute则可以在session域声明这么一个参数。当声明这个注解后，我们在model中加入属性如果与seesion属性名相同，也会存储到session域中。我们通过ModelMap获取我们在session中添加的属性。

示例

1）网页部分：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <!--@SeesionAttribute-->
    <a href="testSessionAttribute">putgogogogo</a>
    <a href="getSessionAttribute">getgogogogo</a>
    <a href="deleteSessionAttribute">deletegogogogo</a>
</body>
</html>

2）控制器部分：

@Controller
@SessionAttributes(value = {"msg"})
public class controllerHelloController {
/**
    * @Description: 向request域与session域中放入msg属性
    * @Param: [model]
    * @return: java.lang.String
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/testSessionAttribute")
    public String testSessionAttribute(Model model){
        model.addAttribute("msg","gogogogogo");
        return "success";
    }

    /**
    * @Description: 获取session域中的msg
    * @Param: [modelMap]
    * @return: java.lang.String
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/getSessionAttribute")
    public String getSessionAttribute(ModelMap modelMap){
        String str = (String)modelMap.get("msg");
        System.out.println(str);
        return "success";
    }

    /**
    * @Description: 清除两个域中的值
    * @Param: [status]
    * @return: java.lang.String
    * @Author: XHY
    * @Date: 2020/4/29
    */
    @RequestMapping("/deleteSessionAttribute")
    public String deleteSessionAttribute(SessionStatus status){
        status.setComplete();
        return "success";
    }
}

 

原来是肖某人
关注
专栏目录
前端文件注释和方法注释总结
棠樾的博客
03-25 1329
文件注释： 文件头部增加文件注释，用于描述文件的基本信息。便于阅读代码时，快速的理解该文件的功能。 主要包含以下字段： @description 文件描述 @author 作者 @date 创建时间 @lastModifiedBy 最新的变更人 @lastModifiedTime 最新的更新时间 /** * @description 文件干啥用的 * @author Morning * @date 2022-03-25 16:16:52 * @lastModifiedBy Morni
SpringMVC——注解配置SpringMVC以及执行流程
ouyangkq666的博客
12-27 495
一、注解配置SpringMVC 1、创建初始化类，代替web.xml 2、创建SpringConfig配置类，代替spring的配置文件 3、创建WebConfig配置类，代替SpringMVC的配置文件 二、SpringMVC执行流程 1、SpringMVC常用组件 2、DispatcherServlet初始化过程 3、DispatcherServlet调用组件处理请求 4、SpringMVC的执行流程
js注释规范
selfsummer的博客
03-17 443
@param @argument 指定参数名和说明来描述一个函数参数 @returns 描述函数的返回值 @author 指示代码的作者 @deprecated 指示一个函数已经废弃，而且在将来的代码版本中将彻底删除。要避免使用这段代码 @see 创建一个HTML链接，指向指定类的描述 @version 指定发布版本 @requires 创建一个HTML链接，指向这个类所需的指定类 @throws @exception 描述函数可能抛出的异常的类型 {@link} 创建一个HTML链接，指.
IDEA注释设置类、方法注释模板(params和return显示)
weixin_45428910的博客
01-05 1005
IDEA注释设置类、方法注释模板(params和return显示)
JavaScript常用注释规范
weixin_44799428的博客
01-13 1358
JavaScript注释规范
JS继承实现方式梳理
qq_32077521的博客
10-24 124
ES5中定义类 在ES5里面定义类，就是写一个方法，这个方法就是该类的构造函数，用来初始化实例对象 /** * @description: 定义Person类 * @param {*} name * @param {*} age * @return {*} */ function Person(name,age){ //定义属性 thi
springmvc文件上传.docx
06-19
在Controller层，可以通过`@RequestParam`注解接收前端传递过来的`MultipartFile`对象，然后进行相应的处理逻辑，如检查文件是否为空、获取文件名、保存文件等。 ```java @RequestMapping("/upload") public String...
04蚂蚁-源码分析——3.手写SpringMVC框架之手写手写@Service和@Resource注解
qq_28461661的博客
08-27 249
SpringIOC原理 XML技术 什么是XML 它是可扩展标记语言（Extensible Markup Language，简称XML），是一种标记语言。 XML 全称为可扩展的标记语言。主要用于描述数据和用作配置文件。 XML 文档在逻辑上主要由一下 5 个部分组成： XML 声明：指明所用 XML 的版本、文档的编码、文档的独立性信息 文档类型声明：指出 XML 文档所用的 DTD 元素：由开...
SpringMVC(8)——注解配置SpringMVC、SpringMVC汇总、＜mvc:annotation-driven＞作用
最新发布
zjr_java的博客
03-28 513
同时它还提供了：数据绑定支持，@NumberFormatannotation支持，@DateTimeFormat支持，@Valid支持，读写XML的支持（JAXB，读写JSON的支持（Jackson）。我们处理响应ajax请求时，就使用到了对json的支持（配置之后，在加入了jackson的core和mapper包之后，不写配置文件也能自动转换成json，之前在别的章节就演示过了）通过源码分析DispatcherServlet调用各个组件处理请求的过程。说明：不演示文件上传是否实现。
SpringMVC基础（2）——常用注解、SpringMVC之响应
波波鱼的博客
07-04 954
目录 1.常用注解 1.1 RequestParam 1.2 RequestBody 1.3 PathVariable （1）Restful风格 （2）演示PathVariable注解的示例代码： （3）HiddentHttpMethodFillter过滤器 1.4 RequestHeader 1.5 CookieValue 1.6 ModelAttribute （1）基于P...
前端代码规范JS/ES6
ICEBOUND47的博客
04-29 572
1.声明变量 建议不再使用var，而使用let 和const 。优先使用const。 ES6提出了两个新的声明变量的命令：let 和 const 这两个声明实现了块作用域，同时屏蔽了遍历提升 对于常量或不修改的变量声明使用const，对于只在当前作用域下有效的变量，应使用let，全局变量可以继续使用var。将所有 const 变量放在一起，然后将所有 let 变量放在一起 const foo = ...
@Param注解
qq_32865713的博客
09-15 1万+
目录 使用Param注解情况 1.传递单个参数,不使用 @Param 注解 2.传递单个参数,使用@Param注解 3.传递多个参数，使用 @Param 注解 4.传递多个参数,不使用 @Param 注解 官方文档:http://www.mybatis.org/mybatis-3/zh/java-api.html 来源文章1：https://blog.csdn.net/Mrqian...
IDEA类和方法注释模板，配置方法注释@param时自动参数的问题，亲自实践总结有效。
热门推荐
落枫的博客
06-27 6万+
如题，使用idea的时候，因为它预定义的注释样式不尽人意，但还好的是支持自定义模板。 自定义模板 File->Settings 图一 然后搜索Live Templates ,之后添加一个自己的模板组，我的是myGroup,然后是添加自己的快速注释快捷键等等，关于如何添加这个的过程大家可以在网上搜到很多,我就不多说了。 敲黑板，重点来了，对于新手来说，如何配置下面这部分无...
封装获取url参数方法
逆水行舟，不进则退
05-23 554
封装获取url参数方法 /** * @description: 封装获取url参数方法 * @param {type} * @return: */ function getUrlParam() { this.parameter = location.search.substr(1); // 获取url中"?"符后的字串 this.parameterJs...
JavaScript的@param注解
seimeii的博客
09-18 1万+
@property name {String} 交互类型 @property params {Object} 附带参数 @property func {Function} 回调函数 /** * 获取事件在列表中的位置 * @param context * @param callback * @private */ _evIndex(event, context, callback) { let index = -1; for (let i = 0; i <= ...
【IntelliJ IDEA】〖优化〗IDEA方法注释模板，优化@param和@return的返回值，解决‘@param xxx‘ tag description is missing参数报错问题
Need not to know
01-10 1万+
〖优化〗IDEA方法注释模板，优化@param和@return的返回值，解决’@param xxx’ tag description is missing参数报错问题 IDEA方法注释模板 优化@param和@return的返回值 解决’@param xxx’ tag description is missing参数报错问题 IDEA方法注释模板     1.点击File→Settings...，然后点击Editor→Live Templates。 &nbsp
idea中 参数没有描述报错 @param XX tag description is missing错误，去除黄色警告
Lewis的博客
11-17 8039
idea中 参数没有描述报错 @param XX tag description is missing错误，去除黄色警告 问题： 最近在使用idea开发工具，在方法备注中参数没有描述报错就会报一些黄色警告： @param XX tag description is missing，下面展示去除黄色警告的方法 解决方法： File–setting–inspections–搜索javadoc 找到Declaration has Javadoc problems 去勾。 ...
Intellij idea 规范代码 生成方法注释模板 自动生成@Param参数 详细设置
goblinsa的博客
01-03 1万+
阿里巴巴编程规范插件中需要你在接口方法上使用javadoc注释，手写的话太麻烦，但是我们可以通过idea设置一个方法注释模板，用来快捷生成方法注释，本文章主要分享的是自动生成参数的模板。       如图，接口方法需要使用javadoc注释。   Alt+Shift+S 打开设置，找到 Editor &gt; Live Templates   点击旁边的加号，选择 ...
SpringMVC：请求参数绑定与@RequestParam、@RequestHeader注解详解
本资源主要讲解了如何通过分析处理方法的签名来实现请求数据的绑定，以及两个常用的注解——@RequestParam和@RequestHeader的应用。 首先，SpringMVC对控制器方法的签名非常灵活，允许开发者按照自己的需求定义方法...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

原来是肖某人

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值