Springmvc常用的注解代码示例_Java

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

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
}