SpringMVC

关于Spring MVC#

Spring MVC是基于Spring框架基础之上的，主要解决了后端服务器接收客户端提交的请求，并给予响应的相关问题。

MVC = Model + View + Controller，它们分别是：

Model：数据模型，通常由业务逻辑层（Service Layer）和数据访问层（Data Access Object Layer）共同构成
View：视图
Controller：控制器

MVC为项目中代码的职责划分提供了参考。

需要注意：Spring MVC框架只关心V - C之间的交互，与M其实没有任何关系。

简单的接收请求#

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

控制器组件必须添加@Controller注解才会被框架视为控制器，才可以用于接收请求、响应结果。

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

自定义处理请求的方法

在方法上使用@RequestMapping系列注解配置请求路径

1
@Controller
2
public class CategoryController {
3
    //启动项目，访问路径:localhost:8080/delete-category (无返回值会500，报错忽略)
4
    @RequestMapping("/delete-category")
5
    public void delete() {
6
        System.out.println("CategoryController.delete()");
7
    }
8
}

关于处理请求的方法：

访问权限：应该是public
返回值类型：当返回值类型为String时，表示返回“视图”的名称，这不是前后端分离的做法；当使用了“响应正文”的模式后，返回的字符串将作为“正文”响应到客户端，这是前后端分离的做法

方法名称：自定义

1
@Controller
2
public class CategoryController {
3
    //启动项目，访问路径:localhost:8080/delete-category (有返回值会404,找页面)
4
    @RequestMapping("/delete-category")
5
    public String delete() {
6
        System.out.println("CategoryController.delete()");
7
        return "del";
8
    }
9
}

关于响应正文#

当处理请求的方法是响应正文的，则方法的返回值会响应到客户端。

在处理请求的方法上添加@ResponseBody，则此方法响应的方式就是响应正文的。

1
@Controller
2
public class CategoryController {
3
    //将java对象转为json格式的数据
4
    @ResponseBody
5
    @RequestMapping("/delete-category")
6
    public String delete() {
7
        System.out.println("CategoryController.delete()");
8
        return "del";
9
    }
10
}

在控制器类上添加@ResponseBody，则此控制器类中所有方法响应的方式都是响应正文的。

1
@Controller
2
@ResponseBody
3
public class CategoryController {
4
    //...
5
}

更推荐在控制器类上使用@RestController，它同时使用@Controller和@ResponseBody作为元注解，所以，同时具有这2个注解的效果！

1
@RestController
2
public class CategoryController {
3
    //...
4
}

附：@RestController源代码：

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

关于@RequestMapping#

此注解的主要作用是配置“请求路径”与“处理请求的方法”的映射关系此注解还可以添加在控制器类上(设置统一前缀)

1
 @RestController
2
 @RequestMapping("/categories")
3
 public class CategoryController {
4

5
     public CategoryController(){
6
         System.out.println("创建控制器对象.CategoryController");
7
     }
8

9
     //启动项目，访问路径：http://localhost:8080/categories/delete
10
     @RequestMapping("/delete")
11
     public String delete(){
12
         System.out.println("CategoryController.delete()");
13
         return "del";
14
     }
15

16
 }

练习#

在CategoryController添加以下处理请求的配置：

/categories/update-by-id：根据id修改类别信息
/categories/list：查看类别列表

在BrandController中添加以下处理请求的配置：

/brands/add-new：增加品牌
/brands/update-by-id：根据id修改品牌信息
/brands/delete-by-id：根据id删除品牌信息
/brands/list：查看品牌列表

配置完成后，应该可以通过浏览器进行访问，且配置的各方法能够响应简单的文本，表示已响应。

接收请求参数#

在Spring MVC中，可以将“请求参数”直接设计为“处理请求的方法的参数”，在方法体内部可以直接使用。

以“增加品牌”为例，客户端需要提交的数据有：

名称
拼音
LOGO图片
类别
简介
关键词
排序值

则处理请求的方法可以设计为：

1
@RequestMapping("/add-new")
2
public String addNew(String name, String pinyin, Integer sort) {
3
    System.out.println("BrandController.addNew()");
4
    System.out.println("接收到的请求参数：名称=" + name);
5
    System.out.println("接收到的请求参数：拼音=" + pinyin);
6
    System.out.println("接收到的请求参数：排序号=" + sort);
7
    return "尝试增加品牌（尚未完成）";
8
}

当客户端提交的请求参数是有效值时（例如?name=XiaoMi），处理请求的方法中的参数也是有效值（就是提交过来的值）。

当客户端只提交了请求参数对应的名称却没有值时（例如?name=），处理请求的方法收到的将是长度为0的字符串，如果参数是String类型，则参数值就是""，如果参数不是String类型（例如Integer类型），也无法正确的实现转换，则参数值为null。

当客户端没有提交对应的参数时（无此参数，或名称不对应），处理请求的方法中的参数值为null。

更推荐将各请求参数封装到自定义的类中，

1
package cn.tedu.csmall.server.pojo.dto;
2

3
import java.io.Serializable;
4
import java.util.Objects;
5

6
public class BrandAddNewDTO implements Serializable {
7

8
    private String name;
9
    private String pinyin;
10
    private String logo;
11
    private Long categoryId;
12
    private String description;
13
    private String keywords;
14
    private Integer sort;
15

16
    // Setters & Getters
17
    // hashCode() & equals()
18
    // toString()
19
}

1
// http://localhost:8080/brands/add-new?name=XiaoMi&pinyin=xiaomi&logo=xxx&categoryId=998&description=hahaha&keywords=mi&sort=66
2
@RequestMapping("/add-new")
3
public String addNew(BrandAddNewDTO brandAddNewDTO) {
4
    System.out.println("BrandController.addNew()");
5
    System.out.println("接收到的请求参数：" + brandAddNewDTO);
6
    return "尝试增加品牌（尚未完成）";
7
}

关于POJO规范#

所有的POJO类型都应该符合以下设计标准：

所有属性都是私有的（private）
每个属性都有对应的、命名规范的Setter & Getter
- 通过专业的开发工具生成即可
应该生成hashCode()和equals()方法，且保证：2个对象中所有属性值都相同时，返回相同的hashCode()，且这2个对象的equals() 对比结果为true
- 通过专业的开发工具生成即可
- 通过IntelliJ IDEA生成时，还有多种代码模版可选择，选择任何一个模版均可
实现序列化接口（Serializable）
- 可以不生成序列化版本ID

以上规范是业内共同认可的，且认为你都会按此规范来编码，所以，许多框架都会自动调用其中的Setter & Getter方式，甚至会使用Serializable来声明你的对象。

关于POJO类的命名#

在项目中，可能存在多种定位不同的POJO类型，例如某些类型中的属性是与数据库中的表字段一一对应的，这种类型通常称之“实体”，但是，它并不能解决此种数据类型的所有业务！

以“用户”数据为例，数据表中的字段可能有：

ID
用户名
密码
昵称

当用户注册时，涉及的只有：用户名、密码、昵称，并不涉及ID

当用户登录时，涉及的只有：用户名、密码，并不涉及ID和昵称

用户登录时，可能还需要提交“验证码”，原本的实体类并没有

当用户需要修改密码时，需要提交的是：原密码、新密码、确认新密码，原本的实体类将不可用

所以，实体类型并不适用于每个业务！客户端发起的不同请求，需要提交的数据都是不同的！另外，从数据库中查询的数据，也不应该使用实体类型，因为每次查询所需要的数据是不同的！

综合来看，客户端提交的数据与实体可能是不同的，从数据库中查询的结果和实体可能也是不同的，所以，在项目中会存在多种定位不同的POJO类型，通常，不同定位的POJO类型，在命名时，应该添加一些后缀：

阿里巴巴的建议：
【参考】各层命名规约：

数据对象：xxxDO，xxx 即为数据表名。 >

DO = Data Object

数据传输对象：xxxDTO，xxx 为业务领域相关的名称。 >

DTO = Data Transfer Object

展示对象：xxxVO，xxx 一般为网页名称。 >

VO = View Object

VO = Value Object

POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

在项目中，每种定位的POJO到底使用什么后缀，并没有标准的约定，只要满足：

不使用POJO作为后缀
同种定位的多个类，使用相同的后缀

小结#

你应该：

了解前后端分离的开发模式（服务器端将响应正文，不再负责处理页面）
掌握响应正文的做法
掌握查看注解源代码的技能
掌握@RequestMapping系列注解的使用
掌握接收请求参数的2种做法
掌握POJO类的规范

练习#

参考“酷鲨商城运营管理平台原型教程（开发版）v1.2.docx”文档，实现：

4.3 添加类别
- 请求参数，参考文档中的截图
4.4 编辑类别
- 请求参数，参考文档中的截图
4.5 删除类别
- 请求参数为：Long id
6.4 编辑品牌
- 请求参数，参考文档中的截图
6.5 删除品牌
- 请求参数为：Long id

在控制器中，能接收以上请求，且接收到各请求的参数。

RESTful#

RESTful是一种设计风格（并不是规范或标准）。

RESTful的典型表现为：将id或类似具有“唯一性”的参数值作为URL的一部分，而不像传统参数那样体现。

例如：

1
https://blog.csdn.net/qq_43505820/article/details/106649178

以上URL，如果使用传统做法，通常会设计为：

1
https://blog.csdn.net/article/details?username=qq_43505820&id=106649178

注意：不具备“唯一性”的参数值通常不会设计为URL的一部分。

Spring MVC很好的支持了RESTful，在配置请求路径时，可以在路径中使用{}框住自定义的名称表示占位符，则客户端在提交请求时，占位符位置的内容可以是任意内容，在方法的参数列表中，接收参数时，需要在参数前添加@PathVariable注解，以表示此参数值是从URL中的占位符位置获取的值，例如：

1
// http://localhost:8080/brands/6937/edit?name=XiaoMi&pinyin=xiaomi&logo=xxx&categoryId=998&description=hahaha&keywords=mi&sort=66
2
@RequestMapping("/{id}/edit")
3
public String edit(@PathVariable Long id, BrandEditDTO brandEditDTO) {
4
    System.out.println("BrandController.edit()");
5
    System.out.println("接收到的请求参数：id=" + id);
6
    System.out.println("接收到的请求参数：" + brandEditDTO);
7
    return "尝试编辑品牌（尚未完成）";
8
}

同一个请求路径中，允许有多个{}占位符，则处理请求的方法也应该有多个对应的参数，每个参数前都添加@PathVariable即可。

如果占位符的名称与方法的参数名称不匹配，还可以在@PathVariable注解中配置参数名称，注解中配置的名称应该与占位符中的名称一致，例如：

1
@RequestMapping("/{id}/edit")
2
public String edit(@PathVariable("id") Long brandId, BrandEditDTO brandEditDTO) {
3
    // 暂不关心方法体的代码
4
}

在使用占位符时，还可以在占位符的名称之后添加冒号，再添加正则表达式，以匹配到符合格式的URL，例如：

1
@RequestMapping("/{id:[0-9]+}/edit")
2
public String edit(@PathVariable Long id, BrandEditDTO brandEditDTO) {
3
    // 暂不关心方法体的代码
4
}

后续，当客户端提交请求时，如果占位符位置的值不符合正则表达式，将响应404错误！

另外，不冲突的多个正则表达式配置的占位符是允许共存的，例如：

1
@RequestMapping("/{id:[0-9]+}/edit")
2
public String edit(@PathVariable Long id, BrandEditDTO brandEditDTO) {
3
    // 暂不关心方法体的代码
4
}
5

6
@RequestMapping("/{name:[a-zA-Z]+}/edit")
7
public String edit(@PathVariable String name, BrandEditDTO brandEditDTO) {
8
    // 暂不关心方法体的代码
9
}

甚至，还可以存在精确匹配的路径与以上占位符的配置共存，例如：

1
@RequestMapping("/test/edit")
2
public String edit(BrandEditDTO brandEditDTO) {
3
    // 暂不关心方法体的代码
4
}
5

6
@RequestMapping("/{id:[0-9]+}/edit")
7
public String edit(@PathVariable Long id, BrandEditDTO brandEditDTO) {
8
    // 暂不关心方法体的代码
9
}
10

11
@RequestMapping("/{name:[a-zA-Z]+}/edit")
12
public String edit(@PathVariable String name, BrandEditDTO brandEditDTO) {
13
    // 暂不关心方法体的代码
14
}

关于RESTful，其实，还有一些其它的建议，例如，RESTful推荐根据要操作数据的方式来决定请求方式，例如：

请求的目标是增加数据时，推荐使用POST请求方式
请求的目标是删除数据时，推荐使用DELETE请求方式
请求的目标是修改数据时，推荐使用PUT请求方式
请求的目标是查询数据时，推荐使用GET请求方式

事实上，在主流的业务系统的开发中，仍只使用GET和POST请求方式。

最后，关于RESTful风格的URL，如果没有更好的选择，推荐设计为：

/数据类型的复数名称表示查询列表，例如，查询品牌列表，URL设计为/brands

1
@RestController
2
@RequestMapping("/brands")
3
public class BrandController {
4
   // http://localhost:8080/brands
5
   @GetMapping("")
6
   public ... // 处理请求的方法
7
}

/数据类型的复数名称/{id}表示根据id查询数据，例如，根据id查询品牌详情，URL设计为/brands/{id}

1
@RestController
2
@RequestMapping("/brands")
3
public class BrandController {
4
   // http://localhost:8080/brands/9527
5
   @GetMapping("/{id:[0-9]+}")
6
   public ... // 处理请求的方法
7
}

/数据类型的复数名称/{id}/命令表示根据id操作数据，例如，根据id删除品牌，，URL设计为/brands/{id}/delete

1
@RestController
2
@RequestMapping("/brands")
3
public class BrandController {
4
   // http://localhost:8080/brands/9527/delete
5
   @PostMapping("/{id:[0-9]+}/delete")
6
   public ... // 处理请求的方法
7
}

参考“酷鲨商城运营管理平台原型教程（开发版）v1.2.docx”文档，实现：

4.3 添加类别（/categories/add-new）
- 请求参数，参考文档中的截图
4.4 编辑类别（/categories/{id}/update）
- 请求参数，参考文档中的截图
4.5 删除类别（/categories/{id}/delete）
- 请求参数为：Long id

示例：

1
axios.post().then((response)=>{
2
let result = response.data;
3
// code:1 - message:OK
4
// code:2 - message:名称被占用
5
// 3 - 插入失败
6
// 4 - 服务器忙
7
if(result.data == 1){
8
// 显示成功
9
}else if(result.data == 2){
10
// 提示错误
11
}else if(result.data == 3){
12
// 提示错误
13
}else if(result.data == 4){
14
// 提示错误
15
}
16
})

关于Spring MVC#

简单的接收请求#

关于响应正文#

关于@RequestMapping#

练习#

接收请求参数#

关于POJO规范#

关于POJO类的命名#

小结#

练习#

RESTful#

评论区

日历

日历

SpringMVC

关于Spring MVC#

简单的接收请求#

关于响应正文#

关于@RequestMapping#

练习#

接收请求参数#

关于POJO规范#

关于POJO类的命名#

小结#

练习#

RESTful#

相关文章

评论区