SpringBoot Http响应

相关注解

@ResponseBody

类型

方法注解、类注解

位置

Controller方法、类上

作用

将方法返回值直接响应，__如果返回类型是实体或集合对象，则将其转化为JSON格式响应 __。

@Controller
@ResponseBody
public class HelloController {
    @RequestMapping("/{path}")
    public Map<String,String> hello(@PathVariable String path){
        return new HashMap<String,String>(){{
            put("name","zoffy");
            put("writer","chen");
        }};
    }
}

{
    "name": "zoffy",
    "writer": "chen"
}

在这里，我使用了@ResponseBody这个注解，可以看到得到了一个Json类型的数据。

@RestController

• 在我们日常使用SpringBoot时，似乎并没有手动使用过@ResponseBody这个注解，那么又是怎么返回响应的呢?

实际上，虽然我们似乎没在开发中敲过@ResponseBody这个注解，但我们经常使用@RestController这个注解

。

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

我们查看它的源码可以发现，除了三个元注解外，@RestController还包含了@Controller和@ResponseBody注解这两个注解。

统一规范

问题

由上可以发现，使用@ResponseBody返回的数据有时是字符串，有时是JSON数据，在实际开发中，前端人员将难以对接后端的数据。因此，我们最好实现一个规范的结果类用于向前端返回数据。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result {
    private Integer code;
    private String msg;
    private Object data;
    public static Result success(){
        return new Result(1,"success",null);
    }
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

我们创建这样一个结果类，code表示状态码，msg表示错误信息，用object对象data保存结果信息，这样，前端人员只需要按照需要从data中获取需要的信息即可，这样也更加规范。

在这里使用了lombok的三个注解，@Data,@AllArgsConstructor,@NoArgsConstructor分别实现了类的get、set方法和有参和无参构造方法。