Spring Boot中Controller常用注解

@Controller

新建控制器BannerController

@Controller
public class BannerController {

    @GetMapping("/test")
    public String test() {
       return "试一下";
    }
}

如果直接使用@Controller在浏览器输入http://localhost:8080/test会出现报错

这个错误是由于controller需要返回一个Response对象，这里改造以下test方法，引入@ResponseBody注解

@ResponseBody

@ResponseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。
注意：在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

@Controller
public class BannerController {

    @GetMapping("/test")
    @ResponseBody
    public String test() {
        return "试一下";
    }
}

可以看到浏览器已经返回了正确结果

在test方法上，有一个注解@GetMapping("/test")，它就是下面要说的路由

路由（Routes）

这里的路由就是指http method。（GET,POST,PUT,PATCH,DELETE）。

HTTP Methods

在Spring boot中，http method可以被用类似*Mapping的格式来表示

其中@RequestMapping注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH。

以下几个都是属于它的组合注解

@GetMapping

@PostMapping

@PutMapping

@PatchMapping

@DeleteMapping

举例: @GetMapping，它所扮演的是 @RequestMapping(method =RequestMethod.GET) 的一个快捷方式。

@Controller
public class BannerController {

    @GetMapping("/test")
    @ResponseBody
    public String test() {
        return "试一下";
    }

    @RequestMapping(value = "/test2", method = RequestMethod.GET)
    @ResponseBody
    public String test2() {
        return "再试一下";
    }
}

@RestController

从上面的代码可以看出，每一个方法都需要一个@ResponseBody，把这个注解放到类上不就可以省下很多注解

@Controller
@ResponseBody
public class BannerController {

    @GetMapping("/test")
    public String test() {
        return "试一下";
    }

    @RequestMapping(value = "/test2", method = RequestMethod.GET)
    public String test2() {
        return "再试一下";
    }
}

spring 4 新加了一个注解@RestController，主要是使 http 请求返回数据格式为 json 格式，看下源码

org.springframework.web.bind.annotation

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Controller;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

最后，为了Api的自描述性，在类上添加RequestMapping来描述

最终修改后的源码如下

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

    @GetMapping("/test")
    public String test() {
        return "试一下";
    }

    @RequestMapping(value = "/test2", method = RequestMethod.GET)
    public String test2() {
        return "再试一下";
    }
}

浏览器输入http://localhost:8080/banner/test2返回正确结果