REST风格 -- SpringMVC快速入门保姆级教程(四)

简介: REST风格 -- SpringMVC快速入门保姆级教程(四)

前言

为了巩固所学的知识,作者尝试着开始发布一些学习笔记类的博客,方便日后回顾。当然,如果能帮到一些萌新进行新技术的学习那也是极好的。作者菜菜一枚,文章中如果有记录错误,欢迎读者朋友们批评指正。

(博客的参考源码可以在我主页的资源里找到,如果在学习的过程中有什么疑问欢迎大家在评论区向我提出)

四、REST风格

1.了解REST风格

  1. REST风格简介

REST (Representational State Transfer) ,表现形式状态转换,是一种软件架构风格,或者说是一种规范,其强调HTTP应当以资源为中心,并且规范了URI的风格;规范了HTTP请求动作(GET/PUT/POST/DELETE/HEAD/OPTIONS)的使用,具有对应的语义。

  1. REST风格对比传统风格

传统风格资源描述形式:

http://localhost/user/getById?id=1

http://localhost/user/saveUser

对应的REST风格描述形式:

http://localhost/user/1

http://localhost/user

  1. REST风格的优点

1.隐藏资源的访问行为,无法通过地址得知对资源是何种操作

2.书写简化

  1. REST风格增删改查举例

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作

http://localhost/users – 查询全部用户信息 – GET(查询)

http://localhost/users/1 – 查询指定用户信息 – GET(查询)

http://localhost/users – 添加用户信息 POST – (新增/保存)

http://localhost/users – 修改用户信息 – PUT(修改/更新)

http://localhost/users/1 – 删除用户信息 – DELETE (删除)

描述模块的名称通常使用复数,也就是加s的格式描述,表示此类资源,而非单个资源,例如: users、books、accounts。上述行为是约定方式,约定不是规范,可以打破,所以称REST风格,而不是REST规范

2.REST风格写法一般步骤

  1. 设定http请求动作作(动词)

  1. 设定请求参数(路径变量)

3.REST风格快速开发

//@Controller
//@ResponseBody配置在类上可以简化配置,表示设置当前每个方法的返回值都作为响应体
//@ResponseBody
//使用@RestController注解替换@Controller与@ResponseBody注解,简化书写
@RestController     
@RequestMapping("/books")
public class BookController {
//  使用@PostMapping简化Post请求方法对应的映射配置
//  @RequestMapping( method = RequestMethod.POST)
    @PostMapping        
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }
//  使用@DeleteMapping简化DELETE请求方法对应的映射配置
//  @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")    
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }
//  使用@PutMapping简化Put请求方法对应的映射配置
//  @RequestMapping(method = RequestMethod.PUT)
    @PutMapping        
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }
//  使用@GetMapping简化GET请求方法对应的映射配置
//  @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    @GetMapping("/{id}")   
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }
//  使用@GetMapping简化GET请求方法对应的映射配置
//  @RequestMapping(method = RequestMethod.GET)
    @GetMapping            
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
}

4.REST风格中的注解

  1. @RequestMapping

1.名称:@RequestMapping

2.类型:方法注解

3.位置:SpringMVC控制器方法定义上方

4.作用:设置当前控制器方法请求访问路径

5.属性:

value (默认) :请求访问路径

method: http请求动作,标准动作 (GET/POST/PUT/DELETE)

6.范例:

  1. @PathVariable

1.名称:@PathVariable

2.类型:形参注解

3.位置:SpringMVC控制器方法形参定义前面

4.作用:绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应

5.范例:

  1. @RequestBody、@RequestParam、@PathVariable 的区别与应用

区别

1.@RequestParam用于接收ur1地址传参或表单传参

2.@RequestBody用于接收ison数据

3.@PathVariable用于接收路径参数,使用(参数名称}描述路径参数

应用

1.后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广

2.如果发送非ison格式数据,选用@RequestParam接收请求参数

3.采用RESTful进行开发,当参数数量较少时,例如1个,可以采用Pathvariable接收请求路径变量,通常用于传递id值

  1. @RestController

1.名称:@RestController

2.类型:类注解

3.位置:基于springMVC的RESTful开发控制器类定义上方

4.作用:设置当前控制器类为RESTful风格,等同于@Controller@ResponseBody

5.两个注解组合功能

6.范例:

  1. @GetMapping 、@PostMapping 、@PutMapping 、@DeleteMapping

1.名称:@GetMapping @PostMapping @PutMapping @DeleteMapping

2.类型:方法注解

3.位置:基于SpringMVC的RESTfu1开发控制器方法定义上方

4.作用:设置当前控制器方法请求访问路径与请求动作,每种对应下个请求动作

5.例如:@GetMapping对应GET请求

6.属性value (默认) :请求访问路径

7.范例:

5. 案例:基于REST风格页面数据交互

  1. 案例需求:点击新建按钮后台对应方法能运行和保存模拟数据后前台能显示

2. 编码环境准备

  • 创建maven模块,选择webapp开发模板(Archetype)

  • 右键打开模块设置,创建一个目录java,标记为Source源码,并将Language level等级设置成8

  • 在pom.xml中导入坐标
<!--servlet技术支持-->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
<!--springmvc技术支持-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.10.RELEASE</version>
    </dependency>
<!--json转换技术支持-->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
    </dependency>
<!--tomcat服务器-->
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port>
          <path>/</path>
        </configuration>
      </plugin>
  • SpringMvc 全局配置
@Configuration
@ComponentScan({"org.example.controller"})
@EnableWebMvc
public class SpringMvcConfig {
}
  • 容器初始化和中文乱码过滤
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}
  • 实体类book
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
}
  • 相关模块控制器BookController
@RestController
public class BookController {
}
  • 文件结构参考

  1. 用REST风格编写book模块控制器类,编写保存和查询功能

不涉及数据库,用模拟数据代替

@RestController
@RequestMapping("/books")
public class BookController {
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save ==> "+ book);
        return "{'module':'book save success'}";
    }
    @GetMapping
    public List<Book> getAll(){
        System.out.println("book getAll is running ...");
        List<Book> bookList = new ArrayList<Book>();
        Book book1 = new Book();
        book1.setType("计算机");
        book1.setName("SpringMVC入门教程");
        book1.setDescription("小试牛刀");
        bookList.add(book1);
        Book book2 = new Book();
        book2.setType("计算机");
        book2.setName("SpringMVC实战教程");
        book2.setDescription("一代宗师");
        bookList.add(book2);
        Book book3 = new Book();
        book3.setType("计算机丛书");
        book3.setName("SpringMVC实战教程进阶");
        book3.setDescription("一代宗师呕心创作");
        bookList.add(book3);
        return bookList;
    }
}
  1. postman接口示例
  • 查全部

  • 保存图书

  1. 编写前端页面(详情见个人主页资源代码)
  • 前端页面文件结构示例

  1. 配置拦截器,放行tomcat负责的路径(前端)
  • 重启服务器,访问book.html

报错原因分析:SpringMVC拦截了所有请求

  • 配置放行路径
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    //设置静态资源访问过滤,当前类需要设置为配置类,并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候,从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}
  • SpringMVC配置类扫描新配置的放行路径配置类 SpringMvcSupport
@Configuration
@ComponentScan({"org.example.controller","org.example.config"})
@EnableWebMvc
public class SpringMvcConfig {
}
  • 刷新页面

7. 新增模拟数据前台能显示

  1. 前端页面通过异步提交访问后台控制器
  • 新建按钮

  • book.html中的js部分

  • 点击新建按钮

  1. 新增模拟数据前台能读取
  • BookController中的查询方法手动添加模拟数据
  • 重启服务器

`博客内容借鉴了bilibili黑马程序员SSM课程资料,如有侵权,请联系作者删除`

总结

欢迎各位留言交流以及批评指正,如果文章对您有帮助或者觉得作者写的还不错可以点一下关注,点赞,收藏支持一下作者,后续还会更新mybatis, springboot,maven高级,微信小程序,等前后端内容的学习笔记。


相关文章
|
7月前
|
JSON 前端开发 Java
❤️最后的大爆发❤️五万字总结SpringMVC教程——三部曲封神之作(建议收藏)
❤️最后的大爆发❤️五万字总结SpringMVC教程——三部曲封神之作(建议收藏)
189 0
❤️最后的大爆发❤️五万字总结SpringMVC教程——三部曲封神之作(建议收藏)
|
7月前
|
Java 应用服务中间件 Spring
SpringMVC快速入门加登录流程分析
SpringMVC快速入门加登录流程分析
87 0
|
XML 前端开发 Java
源码分析系列教程(05) - 手写SpringMVC
源码分析系列教程(05) - 手写SpringMVC
41 0
|
设计模式 前端开发 Java
SpringMvc框架入门使用(详细教程)
SpringMvc框架入门使用(详细教程)
128 0
|
2月前
|
XML Java 应用服务中间件
SpringMvc的具体操作,如何配置springMvc(完整教程)
一个完整的Spring MVC配置教程,包括引入依赖、配置Tomcat、设置DispatcherServlet、编写Spring配置文件、创建Controller以及测试结果。
201 0
SpringMvc的具体操作,如何配置springMvc(完整教程)
|
7月前
|
前端开发 Java 数据库连接
Springmvc保姆级丝滑教程(一文搞懂系列)(2)
Springmvc保姆级丝滑教程(一文搞懂系列)
|
7月前
|
JSON 前端开发 Java
Springmvc保姆级丝滑教程(一文搞懂系列)(1)
Springmvc保姆级丝滑教程(一文搞懂系列)
206 0
|
前端开发 Java 数据库连接
SpringMVC快速入门
SpringMVC快速入门
|
前端开发 Java 数据库连接
【SpringMVC】JSR 303与interceptor拦截器快速入门
JSR 303是Java规范请求(Java Specification Request)的缩写,意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR,以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。 JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation,Hibernate Validator 是 Bean Validation 的参考实现 . Hibe
|
开发框架 前端开发 Java
初识SpringMVC -- SpringMVC快速入门保姆级教程(一)
初识SpringMVC -- SpringMVC快速入门保姆级教程(一)
158 0