Spring几个常用构建RESTFulAPI的注解

@GetMapping

用于处理GET请求。
@GetMapping("/test") 等同于 @RequestMapping(value = “/test”,method = RequestMethod.GET)

@PostMapping

用于处理POST请求。
@PostMapping("/test") 等同于 @RequestMapping(value = “/test”,method = RequestMethod.POST)

@RequestMapping

全注解,功能比较强大,可以添加很多参数,可以替代以上两个注解,不指定HTTP动词时默认任何一个动词都是可以访问的。@RequestMapping可以指定几个HTTP动词访问,参数method的值可以是一个数组指定多个值,比如:

 @RequestMapping(value = "/test",method = {RequestMethod.GET,RequestMethod.PUT})

类似的组合注解还有**@PutMapping @DeleteMapping @PatchMapping**
不同开头的单词就代表了路由函数要用什么http动词来访问

@ResponseBody

@ResponseBody的作用其实是将java对象转为json格式的数据。
将controller的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到response对象的body区,通常用来返回JSON数据或者是XML数据。

    @RequestMapping(value = "/test1",method = {RequestMethod.GET})
    public void test1(HttpServletResponse response) throws IOException {
        response.getWriter().write("Hello test1");
    }

效果等同于

    @RequestMapping(value = "/test1",method = {RequestMethod.GET})
    @ResponseBody
    public String test1(HttpServletResponse response) {
        return "Hello test1";
    }

如果每个路由函数都想返回responseBody,在每个函数上都加@ResponseBody就很麻烦,我们可以把@ResponseBody提取到控制器上,这样这个控制器中所有的路由函数都会返回responseBody。如:

@Controller
@RequestMapping("/v1/banner")
public class BannerController {

    @RequestMapping(value = "/test1",method = {RequestMethod.GET,RequestMethod.POST})
    @ResponseBody
    public String test1(){
        return "Hello test1";
    }
    
    @RequestMapping(value = "/test2",method = {RequestMethod.GET})
    @ResponseBody
    public String test2(){
        return "Hello test2";
    }
}

可以简化为:

@Controller
@ResponseBody
@RequestMapping("/v1/banner")
public class BannerController {

    @RequestMapping(value = "/test1",method = {RequestMethod.GET,RequestMethod.POST})
    public String test1(){
        return "Hello test1";
    }
    
    @RequestMapping(value = "/test2",method = {RequestMethod.GET})
    public String test2(){
        return "Hello test2";
    }
}

@RestController

以上代码我们还可以再进一步的精简,把@Controller@ResponseBody合并成一个注解@RestController,如下:

@RestController
@RequestMapping("/v1/banner")
public class BannerController {

因为在@RestController中包含了@Controller@ResponseBody@RestController的源码如下:

 * @author Rossen Stoyanchev
 * @author Sam Brannen
 * @since 4.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
...
}

猜你喜欢

转载自blog.csdn.net/xfx_1994/article/details/103854398