Springmvc常用的注解代码示例

 更新时间:2025年11月24日 11:34:37   作者:小王不爱笑132  
本文介绍了SpringMVC中常用的控制器和请求映射注解,包括@Controller、@RequestMapping等,以及请求参数绑定注解,如@RequestParam、@RequestBody等,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧

一、控制器与请求映射注解

1. @Controller

  • 作用:标识当前类为 SpringMVC 控制器,由 Spring 容器自动扫描管理。
  • 代码示例
@Controller // 标识此类为控制器
@RequestMapping("/user")
public class UserController {
    // 控制器方法...
}
  • 讲解:需配合配合 Spring 配置文件中开启组件扫描(<context:component-scan base-package="com.qcby"/>),否则才能使注解生效。

2. @RequestMapping

  • 作用:映射请求 URL 与控制器方法的对应关系,可标注在类或方法上。
  • 代码示例
@Controller
@RequestMapping("/user") // 类级路径(基础路径)
public class UserController {
    // 方法级路径,完整 URL 为 /user/save
    @RequestMapping(
        value = "/save", 
        method = RequestMethod.POST, // 限制请求方式为 POST
        params = "username" // 要求请求必须携带 username 参数
    )
    public String save() {
        System.out.println("用户保存成功");
        return "success";
    }
}
  • 讲解
    • 类级注解 + 方法级注解组合成完整请求路径(如 /user/save)。
    • method 属性指定允许的请求方式(GET/POST 等),不指定则允许所有方式。
    • params 属性用于校验请求参数,确保请求携带指定参数。

二、请求参数绑定注解

1. @RequestParam

  • 作用:解决请求参数名与方法参数名不一致的问题,强制绑定参数。
  • 代码示例
@RequestMapping("/find")
public String find(
    @RequestParam(
        value = "name", // 映射请求参数名(前端传递的参数名为 name)
        required = false, // 非必须传递,默认值为 true
        defaultValue = "guest" // 无参数时的默认值
    ) String username
) {
    System.out.println("用户名:" + username);
    return "success";
}
  • 讲解:若前端传递参数为 name=张三,通过 @RequestParam 可映射到方法参数 username

2. @RequestBody

  • 作用:获取请求体中的原始数据(如 JSON、XML 或表单数据),适用于 POST 请求。
  • 代码示例
@RequestMapping("/getBody")
public String getBody(@RequestBody String requestBody) {
    System.out.println("请求体内容:" + requestBody); // 输出原始请求数据
    return "success";
}
  • 讲解:常用于接收前端发送的 JSON 数据(需配合 Jackson 等 JSON 解析依赖),直接获取字符串形式的请求体。

3. @RequestHeader

  • 作用:获取 HTTP 请求头中的信息(如浏览器类型、Accept 格式等)。
  • 代码示例
@RequestMapping("/getHeader")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
    System.out.println("浏览器信息:" + userAgent); // 输出浏览器类型信息
    return "success";
}
  • 讲解:通过参数 value 指定请求头名称,可获取客户端的环境信息。

4. @CookieValue

  • 作用:获取请求中携带的 Cookie 值(如 JSESSIONID)。
  • 代码示例
@RequestMapping("/getCookie")
public String getCookie(@CookieValue("JSESSIONID") String sessionId) {
    System.out.println("会话 ID:" + sessionId); // 输出当前会话的 JSESSIONID
    return "success";
}
  • 讲解:用于获取客户端存储的 Cookie 数据,常用于会话跟踪。

5. @DateTimeFormat

  • 作用:指定日期类型参数的解析格式,解决字符串与 Date 类型的转换问题。
  • 代码示例
public class User {
    private String username;
    // 指定日期格式为 yyyy-MM-dd HH:mm:ss
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date birthday;
    // getter/setter 省略
}
  • 控制器方法
@RequestMapping("/saveUser")
public String saveUser(User user) {
    System.out.println("生日:" + user.getBirthday()); // 自动转换为 Date 类型
    return "success";
}
  • 讲解:前端传递 birthday=2023-10-01 12:00:00 时,会自动解析为 Date 对象。

三、其他常用注解(扩展)

1. @PathVariable(REST 风格)

  • 作用:获取 URL 路径中的参数(适用于 RESTful 接口)。
  • 代码示例
@RequestMapping("/user/{id}")
public String getUserById(@PathVariable("id") Integer userId) {
    System.out.println("用户 ID:" + userId); // 获取路径中的 id 参数
    return "success";
}
  • 讲解:请求 URL 为 /user/100 时,userId 会被赋值为 100。

2. @ResponseBody

  • 作用:将方法返回值直接作为响应体返回(而非跳转视图),常用于 AJAX 请求。
  • 代码示例
@RequestMapping("/getJson")
@ResponseBody // 返回 JSON 数据,而非视图
public User getJson() {
    User user = new User();
    user.setUsername("张三");
    return user; // 需配合 Jackson 依赖,自动转换为 JSON
}
  • 讲解:需在 Spring 配置文件中开启 <mvc:annotation-driven/> 以支持 JSON 转换。

四、注解使用注意事项

  1. 路径冲突@RequestMapping 标注的路径需唯一,避免不同方法映射同一 URL。
  2. 参数校验@RequestParam 的 required=true 时,若前端未传参数会抛出异常,需注意处理。
  3. 日期转换优先级:自定义类型转换器(实现 Converter 接口)优先级高于 @DateTimeFormat
  4. 配置支持:所有注解需在 Spring 配置文件中开启 <mvc:annotation-driven/> 才能生效(自动注册处理器映射器和适配器)。

到此这篇关于Springmvc常用的注解代码示例的文章就介绍到这了,更多相关Springmvc注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈java多态的实现主要体现在哪些方面

    浅谈java多态的实现主要体现在哪些方面

    下面小编就为大家带来一篇浅谈java多态的实现主要体现在哪些方面。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • Java位图Bitmap从入门到实战应用详解

    Java位图Bitmap从入门到实战应用详解

    位图(Bitmap)作为位运算的经典应用之一,通过巧妙地利用二进制位来表示数据的存在性或状态,实现了对大规模数据的高效存储与处理,这篇文章主要介绍了Java位图Bitmap从入门到实战应用的相关资料,需要的朋友可以参考下
    2025-09-09
  • java web用servlet监听器实现显示在线人数

    java web用servlet监听器实现显示在线人数

    这篇文章主要为大家详细介绍了java web用servlet监听器实现显示在线人数,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-03-03
  • 一文彻底弄懂Spring Boot自动配置

    一文彻底弄懂Spring Boot自动配置

    在SpringBoot框架中自动配置是其最核心的特性之一,也是"约定优于配置"理念的集中体现,这篇文章主要介绍了Spring Boot自动配置的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-11-11
  • spring boot redis中的key失效监听的问题解决

    spring boot redis中的key失效监听的问题解决

    本文主要介绍了spring boot redis中的key失效监听的问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-07-07
  • 使用Java调用海康威视SDK实现摄像头预览超详细教程

    使用Java调用海康威视SDK实现摄像头预览超详细教程

    现在制造业很多都是用的海康的摄像头,作为程序员有时候需要对接海康摄像头,这篇文章主要介绍了使用Java调用海康威视SDK实现摄像头预览的相关资料,需要的朋友可以参考下
    2025-07-07
  • 深入详解Java中synchronized锁升级的套路

    深入详解Java中synchronized锁升级的套路

    synchronized锁是啥?锁其实就是一个对象,随便哪一个都可以,Java中所有的对象都是锁,换句话说,Java中所有对象都可以成为锁。本文我们主要来聊聊synchronized锁升级的套路,感兴趣的可以收藏一下
    2023-04-04
  • Spring如何使用PropertyPlaceholderConfigurer读取文件

    Spring如何使用PropertyPlaceholderConfigurer读取文件

    这篇文章主要介绍了Spring如何使用PropertyPlaceholderConfigurer读取文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Java 内存溢出的原因和解决方法

    Java 内存溢出的原因和解决方法

    这篇文章主要介绍了Java 内存溢出的原因和解决方法,帮助大家更好的维护Java程序,保持稳定性,感兴趣的朋友可以了解下
    2020-12-12
  • 基于SpringBoot实现一个安全可靠的滑块拼图验证系统

    基于SpringBoot实现一个安全可靠的滑块拼图验证系统

    滑块拼图验证是一种行为验证技术,通过要求用户将拼图块拖动到正确位置来区分人类用户和自动化程序,本文给大家介绍了基于SpringBoot实现滑块拼图验证的完整代码,需要的朋友可以参考下
    2026-03-03

最新评论