首页 > 其他分享 >REST风格开发

REST风格开发

时间:2023-05-04 12:02:20浏览次数:22  
标签:return PathVariable REST id book 开发 风格 println public

REST(Representational State Transfer),表现形式状态转换,是一种资源描述形式
根据REST风格对资源进行访问称为RESTful

优点:

  • 隐藏资源的访问行为,无法通过地址得知对资源是何种操作
  • 书写简化


示例


    @PostMapping
    public String save(@RequestBody Book book) {
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id) {
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

    @PutMapping
    public String update(@RequestBody Book book) {
        System.out.println("book update..." + book);
        return "{'module':'book update'}";
    }

    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id) {
        System.out.println("book getById..." + id);
        return "{'module':'book getById'}";
    }

    @GetMapping
    public String getAll() {
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }

在Postman的请求发送类型

注解解释
名称:@RequestMapping
作用:设置当前控制器方法请求访问路径
value(默认):请求访问路径
method:http请求动作,标准动作(GET/POST/PUT/DELETE)
@RequestMapping(value = "/users", method = RequestMethod.POST)

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

@RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id) {
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

@RequestBody @RequestParam @PathVariable
区别:

  • @RequestParam用于接收url地址传参或表单传参
  • @RequestBody用于接收json数据
  • @PathVariable用于接收路径参数,使用{参数名称}描述路径参数
    应用:
  • 后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
  • 如果发送非json格式数据,选用@RequestParam接收请求参数
  • 采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值

RESTful快速开发
前面的注解开发还是有点繁杂,基于RESTful的快速开发诞生,主要是合并注解

  • @ResponseBody不放在方法中,放在类上方,在整个类中都生效
  • @Controller与@ResponseBody --> @RestController
  • @RequestMapping(value = "/users/{id}", method = RequestMethod.Get) --> @GetMapping("/{id}")
  • 共有@GetMapping @PostMapping @PutMapping @DeleteMapping

案例


@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() {
        ArrayList<Book> bookList = new ArrayList<Book>();
        Book book1 = new Book();
        book1.setType("软件工程");
        book1.setName("SpringMVC");
        book1.setDescription("小试牛刀");
        bookList.add(book1);

        return bookList;
    }

}

在快速开发中,要设置对静态资源的访问放行


@Configuration
public class SpringMvcSupports extends WebMvcConfigurationSupport {

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/xxxx不要走mvc,而是走/pages目录下的内容
//        registry.addResourceHandler("/webapp/**").addResourceLocations("/webapp/");
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}

REST风格使得开发有了更好的规范

标签:return,PathVariable,REST,id,book,开发,风格,println,public
From: https://www.cnblogs.com/llg-/p/17370739.html

相关文章

  • 嵌入式工业开发板基础测试手册——基于NXP iMX6ULL开发板(1)
    前言本文档适用开发环境:Windows开发环境:Windows764bit、Windows1064bit虚拟机:VMware15.1.0Linux开发环境:Ubuntu18.04.464bitU-Boot:U-Boot-2020.04Kernel:Linux-5.4.70LinuxSDK:5.4.70_2.3.0进行本文档操作前,请先按照调试工具安装、Linux开发环境搭建相关文档,安装Secu......
  • 基于TI Sitara系列AM5728工业开发板——FPGA视频开发案例分享
    前言31cameralink_display案例41.1案例功能41.2操作说明41.3关键代码(MicroBlaze)111.4Vivado工程说明161.5模块/IP核配置20前言本文主要介绍FPGA视频开发案例的使用说明,适用开发环境:Windows7/1064bit、XilinxVivado2017.4、XilinxSDK2017.4。评估......
  • 推荐一个基于.Net Framework开发的Windows右键菜单管理工具
    平常在我们电脑,我们都会安装非常多的软件,很多软件默认都会向系统注册右键菜单功能,这样方便我们快捷打开。比如图片文件,通过右键的方式,快捷选择PS软件打开。如果我们电脑安装非常多的软件,就会导致我们右键菜单的列表非常多,但是很多软件我们是用不到的。所以,今天给大家推荐一个Win......
  • 嵌入式测试手册——基于NXP iMX6ULL开发板(2)
    基于测试板卡:创龙科技TLIMX6U-EVM是一款基于NXPi.MX6ULL的ARMCortex-A7高性能低功耗处理器设计的评估板,由核心板和评估底板组成。核心板经过专业的PCBLayout和高低温测试验证,稳定可靠,可满足各种工业应用环境。评估板接口资源丰富,引出双路网口、双路RS485、双路CAN、三路USB、......
  • 嵌入式基础测试手册——基于NXP iMX6ULL开发板(4)
    前言本文档适用开发环境:Windows开发环境:Windows764bit、Windows1064bit虚拟机:VMware15.1.0Linux开发环境:Ubuntu18.04.464bitU-Boot:U-Boot-2020.04Kernel:Linux-5.4.70LinuxSDK:5.4.70_2.3.0基于测试板卡:创龙科技TLIMX6U-EVM是一款基于NXPi.MX6ULL的ARMCortex-A7高......
  • 嵌入式基础测试手册——基于NXP iMX6ULL开发板(3)
    基于测试板卡:创龙科技TLIMX6U-EVM是一款基于NXPi.MX6ULL的ARMCortex-A7高性能低功耗处理器设计的评估板,由核心板和评估底板组成。核心板经过专业的PCBLayout和高低温测试验证,稳定可靠,可满足各种工业应用环境。评估板接口资源丰富,引出双路网口、双路RS485、双路CAN、三路USB、......
  • Qt音视频开发43-采集屏幕桌面并推流(支持分辨率/矩形区域/帧率等设置/实时性极高)
    一、前言采集电脑屏幕桌面并推流一般是用来做共享桌面、远程协助、投屏之类的应用,最简单入门的做法可能会采用开个定时器或者线程抓图,将整个屏幕截图下来,然后将图片传出去,这种方式很简单但是性能要低不少,一般采用ffmpeg来做桌面推流的居多,毕竟如果不采用代码直接ffmpeg一行命令即......
  • 【DRF】4. DRF视图开发RESTful API接口
    四种方式:函数式编程:functionbasedview类视图:classedbasedview通用类视图:genericclassedbasedviewDRF的视图集Viewsets原生DjangoFBV(Funcitonbasedview)编写,应用的views.pyimportjsonfromdjango.httpimportJsonResponsefromdjango.views.decorators.csr......
  • 基于.NetCore开发博客项目 StarBlog - (27) 使用JWT保护接口
    前言这是StarBlog系列在2023年的第二篇更新......
  • SpringBoot定义优雅全局统一Restful API 响应框架二
    这里解决之前留下来的问题,当程序没有正常返回时候就是程序由于运行时异常导致的结果,有些异常我们可,能无法提前预知,不能正常走到我们return的R对象返回。这个时候该如何处理在SpringBoot中,可以使用@ControllerAdvice注解来启用全局异常处理。通过使用@ControllerAdvice注解,可以捕......