文档章节

(转)Spring MVC的常用注解

政旭Arvin
 政旭Arvin
发布于 01/18 09:46
字数 1664
阅读 46
收藏 7

@Controller(常用)

注解一个类表示控制器,Spring MVC会自动扫描标注了这个注解的类。

@RequestMapping(常用)

请求路径映射,可以标注类,也可以是方法,可以指定请求类型,默认不指定为全部接收。其中有8个属性:

* value:指定请求的实际地址,指定的地址可以是URI Template 模式。

* method:指定请求的method类型, GET、POST、PUT、DELETE等;  

  consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;  

  produces:   指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;  

  params: 指定request中必须包含某些参数值是,才让该方法处理。  

  headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

@RequestParam

放在参数前,表示只能接收参数a=b格式的数据,即Content-Type为 application/x-www-form-urlencoded类型的内容。 @RequestBody 放在参数前,表示参数从request body中获取,而不是从地址栏获取,所以这肯定是接收一个POST请求的非a=b格式的数据,即Content-Type不为 application/x-www-form-urlencoded类型的内容。

@ResponseBody(常用)

放在方法上或者返回类型前,表示此方法返回的数据放在response body里面,而不是跳转页面。一般用于ajax请求,返回json数据。比如异步请求,希望响应的结果是json数据,那么加上@Responsebody后,就会直接返回json数据。

@RestController

这个是Controller和ResponseBody的组合注解,表示@Controller标识的类里面的所有返回参数都放在response body里面。 @PathVariable 路径绑定变量,用于绑定restful路径上的变量。

@RequestHeader

放在方法参数前,用来获取request header中的参数值。

@CookieValue

放在方法参数前,用来获取request header cookie中的参数值。 GetMapping PostMapping PutMapping.. *Mapping的是Spring4.3加入的新注解,表示特定的请求类型路径映射,而不需要写RequestMethod来指定请求类型。

--------------------------------------------------------------------------------------------------------------------------------    

Controller控制器和@RequestMapping的作用

一、控制器定义
控制器提供访问应用程序的行为,通常通过服务接口定义或注解定义两种方法实现。 控制器解析用户的请求并将其转换为一个模型。在Spring MVC中一个控制器可以包含多个Action(动作、方法)。

使用注解@Controller定义控制器
org.springframework.stereotype.Controller注解类型用于声明Spring类的实例是一个控制器;

Spring可以使用扫描机制来找到应用程序中所有基于注解的控制器类,为了保证Spring能找到你的控制器,需要在配置文件中声明组件扫描。

@Controller
@RequestMapping("/foo")
public class FooController {
 
//    @RequestMapping("/action1")
    @RequestMapping({"/","action1","111"})
    public String action1(Model model){
        model.addAttribute("message","测试action1");
        return "foo/index";
    }
}

二、@RequestMapping详解
@RequestMapping注释用于映射url到控制器类或一个特定的处理程序方法。可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解共有8个属性,注解源码如下:

/**
 * 用于映射url到控制器类或一个特定的处理程序方法.
 */
//该注解只能用于方法或类型上
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
 
    /**
     * 指定映射的名称
     */
    String name() default "";
 
    /**
     * 指定请求的路径映射,指定的地址可以是uri模板,别名为path
     */
    @AliasFor("path")
    String[] value() default {};
 
    /** 别名为value,使用path更加形象
     * 只有用在一个Servlet环境:路径映射URI(例如“/myPath.do”)。
     * Ant风格的路径模式,同时也支持(例如,“/myPath/*.do”)。在方法层面,在主要的映射在类型级别表示相对路径(例如,“edit.do”)
     * 的支持。路径映射的URI可能包含占位符(例如“/$ {}连接”)
     */
    @AliasFor("value")
    String[] path() default {};
 
    /**
     * 指定请求谓词的类型如GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE. 收窄请求范围 The
     * HTTP request methods to map to, narrowing the primary mapping: GET, POST,
     * HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
     */
    RequestMethod[] method() default {};
 
    /**
     * 映射请求的参数,收窄请求范围 The parameters of the mapped request, narrowing the
     * primary mapping.
     */
    String[]params() default {};
 
    /**
     * 映射请求头部,收窄请求范围 The headers of the mapped request, narrowing the primary
     * mapping. RequestMapping(value = "/something", headers =
     * "content-type=text/*")
     */
    String[] headers() default {};
 
    /**
     * 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html,收窄请求范围 The
     * consumable media types of the mapped request, narrowing the primary
     * mapping.
     */
    String[] consumes() default {};
 
    /**
     * 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回 The producible media types
     * of the mapped request, narrowing the primary mapping. produces =
     * "text/plain" produces = {"text/plain", "application/*"} produces =
     * "application/json; charset=UTF-8"
     */
    String[] produces() default {};
}

value:指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

@RequestMapping({"/","action1","111"})
// 仅有value元素可省略
    public String action1(Model model){
        model.addAttribute("message","测试action1");
        return "foo/index";
    }


method:指定请求的method类型, GET、POST、PUT、DELETE等;

  @GetMapping("/action5")   //这是一个组合注解等同下面这个注解
//    @RequestMapping(value = "/action5",method = RequestMethod.GET)
    public String action5(Model model){
        model.addAttribute("message","请求谓语动词是GET");
        return "foo/index";
    }

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

//  请求内容类型必须为text/html
    @RequestMapping(value = "/action6",consumes = "!text/html")
    public String action6(Model model){
        model.addAttribute("message","请求的提交内容类型(Content-Type)是text/html");
        return "foo/index";
    }


produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

// 客户端接收json且编码为utf-8,多数浏览器Accept设置的为*/*,接收任意类型
    @RequestMapping(value = "/action7",produces="application/json; charset=UTF-8")
    public String action7(Model model) {
        model.addAttribute("message", "客户端可以接收的类型是application/json; charset=UTF-8");
        return "foo/index";
    }


params: 指定request中必须包含某些参数值是,才让该方法处理。

// 请求的参数必须包含id=215与name不等于abc
    @RequestMapping(value = "/action8",params={"id=215","name!=abc"})
    public String action8(Model model) {
        model.addAttribute("message", "请求的参数必须包含id=215与name不等于abc");
        return "foo/index";
    }


headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

// 请求头部信息中必须包含Host=localhost:8080
    @RequestMapping(value = "/action9",headers="Host=localhost:8080")
    public String action9(Model model) {
        model.addAttribute("message", "请求头部信息中必须包含Host=localhost:8080");
        return "foo/index";
    }

 

本文转载自:https://blog.csdn.net/qq_42218123/article/details/80526520

政旭Arvin
粉丝 1
博文 23
码字总数 24053
作品 0
长春
私信 提问
Spring 3.x Web MVC

本文demo下载地址:http://www.wisdomdd.cn/Wisdom/resource/articleDetail.htm?resourceId=1142 Spring 3.x Web MVC Spring mvc 特点 @ 功能组件划分细致 @ 灵活、强大 @ 设计思想优秀 MVC框......

智慧点点
2018/08/26
19
0
仿照源码,手写一个自定义 Spring MVC 框架

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 https://blog.csdn.net/GitChat/article/details/97947618 前言 上节课我们学习了 Spring M...

GitChat技术杂谈
07/31
0
0
Spring Boot 常用注解深入

@RestController和@RequestMapping 被称为一个构造型()注解。它为阅读代码的开发人员提供建议。对于Spring,该类扮演了一个特殊角色。它继承自@Controller注解。4.0之前的版本,spring MV...

小致dad
2018/07/15
206
0
【Spring boot实践】Spring boot下的Spring MVC

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/Rsx/article/details/89194640 文章目录 Spring MVC的几种注解 Controller注解 @Controller注解是在Spring的o...

不专业得Cook
04/15
0
0
Spring MVC配置使用入门

SpringMVC 应用开发 一、Spring MVC介绍 Spring MVC属于SpringFrameWork的后续产品,已经融合在SpringWeb Flow里面。Spring 框架提供了构建 Web 应用程序的全功能 MVC 模块。 二、在项目中引...

lilugoodjob
2018/07/02
0
0

没有更多内容

加载失败,请刷新页面

加载更多

浅谈Command命令模式

一、前言 命令也是类,将命令作为一个类来保存,当要使用的时候可以直接拿来使用,比如脚本语言写出的脚本,只需要一个命令就能执行得到我们想要的需要操作很长时间才能得到的结果。这是一个...

青衣霓裳
6分钟前
1
0
Less导入指令

在标准CSS中,@import 规则必须位于所有其他类型的规则之前。但是Less.js不在乎我们将 @import 语句放在什么位置。 @import 伪指令常用于在代码中导入文件,它将Less 代码分布在不同的文件上...

凌兮洛
7分钟前
1
0
【apk】空包签名

命令语法 jarsigner -verbose -keystore [keystorePath] -signedjar [apkOut] [apkIn] [alias] 例 子: jarsigner -verbose -keystore F:\签名\laidianyi_customer.keystore -signedjar F:\......

Agnes2017
10分钟前
2
0
虚拟化的操作技巧!

从物理基础设施迁移到虚拟基础设施时,虚拟环境的设计和布局应模仿物理做法,企业级虚拟化软件允许创建虚拟交换机,虚拟局域网(VLANS)和私有网络可以协助迁移,分析物理和逻辑网络图,复制...

青果云小潘
14分钟前
2
0
SEO网站运营助手

SEO网站运营助手有哪些功能? 提交: 百度链接主动提交 + 熊掌号周推(支持500万条提交额,所以合并在一起提交) 更新: 网站内容改动后,对于已收录的链接,可以选择更新 查询: 对百度收录判断...

NoCome
16分钟前
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部