Spring MVC笔记整理

Spring MVC的作用

Spring MVC框架主要解决了接受请求、响应结果的相关问题。

开发环境

在使用Spring MVC框架时，需要在项目中添加 spring-webmvc 的依赖项。
如果使用的是Spring Boot工程，只需要添加 spring-boot-starter-web 依赖项即可。
说明：在 spring-boot-starter-web 依赖项中，包含了 spring-boot-starter ，所以，在Spring Boot项目中，只需要将原有 spring-boot-starter 改为 spring-boot-starter-web 即可。

简单的接收请求

通常，会使用“控制器”组件来接收请求，这类组件通常使用 Controller 作为类名的后缀，例如类名为 CategoryController、BrandController等。

在Spring MVC中，当需要接收请求时，只需要在容器中：

• 自定义处理请求的方法：
• 在方法上使用 @RequestMapping 系列注解配置请求路径。

@RequestMapping

• 关于处理请求的方法：
• 访问权限：应该是 public
• 返回值类型：当返回-值类型为 String 时，表示返回“视图”的名称，这不是前后前端分离的做法；当时用了“响应正文”的模式后，返回的字符串将作为“正文”响应到客户端，这是前后端分离的做法。
• 方法名称：自定义

关于响应正文

当处理请求的方法是响应正文的，则方法的返回值会响应到客户端。
在处理请求的方法上添加 @ResponseBody ，则此方法响应的方式就是响应正文的。
在控制类上添加 @ResponseBody ，则此控制器类中所有方法响应的方式都是响应正文的。
更推荐在控制器类上使用 @RestController ，它同时使用 @Controller 和 @ResponseBody 作为元注解，所以，同时具有这2个注解的效果！

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
 	/**
 	 * The value may indicate a suggestion for a logical component name,
 	 * to be turned into a Spring bean in case of an autodetected component.
 	 * @return the suggested component name, if any (or empty String otherwise)
	 * @since 4.0.1
 	 */
	@AliasFor(annotation = Controller.class)
 	String value() default "";
 }

关于@RequestMapping

此注解的主要作用是配置“请求路径”与“处理请求方法”的映射关系。
此注解还可以添加在控制器上，例如：

@RestController
@RequestMapping("/categories")
public class CategoryController {
}

则此类中任何一个处理请求的路径都必须以此为前缀，例如：

@RestController
@RequestMapping("/categories")
public class CategoryController {

    // http://localhost:8080/categories/add-new
    @RequestMapping("/add-new") 
    public String addNew() {
        System.out.println("CategoryController.addNew()");
        return "已经处理增加类别的请求";
    }
    
}

在配置路径时，其实，路径值并不需要使用‘/’作为第1个字符，除非路径值只有‘/’这1个字符，否则，配置值（字符串）两端的‘/’都是可以无视的，最终拼接出来的完整的URL会自动在中间添加‘/’。
推荐每个配置值都使用‘/’作为第1个字符（尽管可以不写）。
在 @RequestMapping 注解中，还有 method 属性，可以限制请求方式（GET、POST等），其语法大概是：

@RequestMapping(value = "/add-new", method = RequestMethod.POST)

以上配置表示“只允许使用POST方式提交请求”，如果使用其他请求方式，将出现405错误！
在Spring MVC框架中，定义一系列的限制请求方式的注解，例如：

• @GetMapping：将请求方式限制为GET，除了不能添加在类上，其它用法与 @RequestMapping 相同。
• @PostMapping：将请求方式限制为POST，除了不能添加在类上，其它方法与 @RequestMapping 相同。
• 其它。

在开发实践中，控制器类上使用@RequestMapping，在方法上使用 @GetMapping 或 @PostMapping，通常，以‘获取数据’为主要目的的请求应该使用 @GetMapping （例如查看订单列表、查看商品详情），否则，使用 @PostMapping 。

关于注解的源代码

每个注解的源代码中，其元注解@Target表示此注解可以添加在哪个位置，例如：

@Target({ElementType.TYPE, ElementType.METHOD})

则表示此注解可以添加在TYPE（类）上，也可以添加在METHOD（方法）上。

在注解的内部，源代码例如：

String[] value() default {};

以上value是注解中可配置的属性，String[]表示此属性的值类型，default {}表示此属性的默认值是空数组。

每个注解的value属性都是默认属性，在配置时，如果只配置这1个属性的值，并不需要显式的添加此属性名称，例如：

@RequestMapping({"/delete"})

和

@RequestMapping(value = {"/delete"})

以上2种配置是完全等效的！

如果属性的值类型是数组类型的，且如果需要配置的值只有1个时，可以不使用大括号框住值，例如：

@RequestMapping(value = {"/delete"})

和

@RequestMapping(value = "/delete")

以上2种配置是完全等效的！

所以，关于@RequestMapping的value属性，以下4种配置是完全等效的：

@RequestMapping("/delete")
@RequestMapping({"/delete"})
@RequestMapping(value = "/delete")
@RequestMapping(value = {"/delete"})

另外，在Spring系列框架的注解中，经常出现@AliasFor注解，例如：

@AliasFor("path")
String[] value() default {};

@AliasFor("value")
String[] path() default {};

以上代码表示value和path是等效的！