springmvc注解@RestController @RequestMapping @GetMapping @PostMapping

蔚落 2022-12-27 12:58 157阅读 0赞

说一说spring中的常用注解

https://www.cnblogs.com/clwydjgs/p/9255046.html  
1)如果只是使用@RestController注解Controller，则Controller中的方法无法返回jsp页面，配置的视图解析器InternalResourceViewResolver不起作用，返回的内容就是Return 里的内容。

例如：本来应该到success.jsp页面的，则其显示success.

2)如果需要返回到指定页面，则需要用 @Controller配合视图解析器InternalResourceViewResolver才行。  
3)如果需要返回JSON，XML或自定义mediaType内容到页面，则需要在对应的方法上加上@ResponseBody注解。

例如：

1.使用@Controller 注解，  
在对应的方法上，视图解析器可以解析return 的jsp,html页面，并且跳转到相应页面

@Controller
    public class FileUploadController {
    
    //跳转到上传文件的页面
    @RequestMapping(value="/gouploadimg", method = RequestMethod.GET)
    public String goUploadImg() {
    //跳转到 templates 目录下的 uploadimg.html
    return "uploadimg";
    }
    
    }

若返回json等内容到页面，则需要加@ResponseBody注解

//处理文件上传
    @RequestMapping(value="/testuploadimg", method = RequestMethod.POST)
    public @ResponseBody String uploadImg(@RequestParam("file") MultipartFile file,
    HttpServletRequest request) {
    System.out.println("调用文件上传方法");
    String contentType = file.getContentType();
    String fileName = file.getOriginalFilename();
    }

2.@RestController注解  
相当于@Controller+@ResponseBody两个注解的结合，返回json数据不需要在方法前面加@ResponseBody注解了，但使用@RestController这个注解，就不能返回jsp,html页面，视图解析器无法解析jsp,html页面

@RestController /* @Controller + @ResponseBody*/
    public class HospitalController {
    
        //注入Service服务对象
        @Autowired
        private HospitalService hospitalService;
    
        /**
         * 查询所有医院信息（未分页）
         */
    
        @RequestMapping(value = "findAllHospital",method = RequestMethod.GET)
        public  List<Hospital> findAllHospital(){
            List<Hospital> hospitalList= hospitalService.findAllHospital();
            return hospitalList;
        }
    }

总结，@Controller返回的是指定页面；@RestController注解相当于@Controller+@ResponseBody两个注解的结合，返回的是json；  
所以如果一般前后端没有分离，后端需要控制页面的跳转则需要使用@Controller；如果前后端做了分离，即页面的跳转都放在了前端，此时一般使用@RestController。@RequestMapping 配置url映射  
@RequestMapping此注解即可以作用在控制器的某个方法上，也可以作用在此控制器类上。  
当控制器在类级别上添加@RequestMapping注解时，这个注解会应用到控制器的所有处理器方法上。处理器方法上的@RequestMapping注解会对类级别上的@RequestMapping的声明进行补充。  
例子：@RequestMapping作用在类级别和处理器方法上

@RestController
    @RequestMapping("/hello")
    public class HelloController {
    
        @RequestMapping(value="/sayHello",method= RequestMethod.GET)
        public String sayHello(){
            return "hello";
        }
        @RequestMapping(value="/sayHi",method= RequestMethod.GET)
        public String sayHi(){
            return "hi";
        }
    }

这样，以上代码中的sayHello所响应的url=localhost:8080/hello/sayHello。

sayHi所响应的url=localhost:8080/hello/sayHi。  
从这两个方法所响应的url可以回过头来看这两句话：当控制器在类级别上添加@RequestMapping注解时，这个注解会应用到控制器的所有处理器方法上。处理器方法上的@RequestMapping注解会对类级别上的@RequestMapping的声明进行补充。

最后说一点的是@RequestMapping中的method参数有很多中选择，一般使用get/post.

@RequestMapping与@GetMapping和@PostMapping  
如果我们想使用传统的@RequestMapping注释实现URL处理程序，那么它应该是这样的：  
@RequestMapping(value = "/get/\{id\}", method = RequestMethod.GET)  
新方法可以简化为：  
@GetMapping("/get/\{id\}")

@GetMapping支持多个@RequestParam参数，请求的参数可以直接放在url中，实例如下

@GetMapping("/lessonReport")
        public ResponseEntity<Body<StuLessonReport>> getStuLessonReport(
                @ApiParam("自定义session的凭证") @RequestHeader(value = "Authorization", required = true) String token,
                @ApiParam("学ID") @RequestParam String sId,
                @ApiParam("级ID") @RequestParam String cId,
                @ApiParam("次Id") @RequestParam String lId
        ) {
            // .......
            return ResponseUtil.ok(report);
        }

@PostMapping仅支持一个@RequestBody，要求参数封装为一个dto，且请求时参数不放在url中

@PostMapping("/lessonReport/practiceDetail")
        public ResponseEntity<Body<PracticeDetailDto>> getPracticeDetail(
                @ApiParam("自定义session的凭证") @RequestHeader(value = "Authorization", required = true) String token,
                @ApiParam("报告题目详情请求参数") @RequestBody PracticeDetailParam param
        ) {
            // .......
            return ResponseUtil.ok(report);
        }