Spring Boot Web与RestfulApi 的开发 基于@Controller @RestController 的使用教程

最新推荐文章于 2022-10-18 20:33:03 发布
最新推荐文章于 2022-10-18 20:33:03 发布
阅读量461 收藏 1
点赞数 1
分类专栏： spring boot 文章标签： spring boot java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fishpro/article/details/104835145
版权

Spring Boot Web与RestfulApi 的开发

在 Spring Boot 中，@Controller 注解是专门用于处理 Http 请求处理的，是以 MVC 为核心的设计思想的控制层。@RestController 则是 @Controller 的衍生注解。

本项目源码下载

1 Spring Boot Controller

1.1 原理

Spring Boot本身就 Spring MVC 的简化版本。是在 Spring MVC 的基础上实现了自动配置，简化了开发人员开发过程。

Spring MVC 是通过一个叫 DispatcherServlet 前端控制器的来拦截请求的。而在 Spring Boot 中 使用自动配置把 DispatcherServlet 前端控制器自动配置到框架中。

例如，我们来解析 /users 这个请求

/users请求流程

  1. DispatcherServlet 前端控制器拦截请求 /users
  2. servlet 决定使用哪个 handler 处理
  3. Spring 检测哪个控制器匹配 /users，Spring 从 @RquestMapping 中查找出需要的信息
  4. Spring 找到正确的 Controller 方法后，开始执行 Controller 方法
  5. 返回 users 对象列表
  6. 根据与客户端交互需要返回 Json 或者 Xml 格式

1.2 相关注解

在 Spring Boot 中使用到 @Controller 及相关的注解如下，主要分为三个层面进行，请求前，处理中，返回。

应用场景注解注解说明
处理请求@Controller处理 Http 请求
处理请求@RestController@Controller 的衍生注解
路由请求@RequestMapping路由请求 可以设置各种操作方法
路由请求@GetMappingGET 方法的路由
路由请求@PostMappingPOST 方法的路由
路由请求@PutMappingPUT 方法的路由
路由请求@DeleteMappingDELETE 方法的路由
请求参数@PathVariable处理请求 url 路径中的参数 /user/{id}
请求参数@RequestParam处理问号后面的参数
请求参数@RequestBody请求参数以json格式提交
返回参数@ResponseBody返回 json 格式

注意以上注解需要强调的是 @RestController 是 @Controller 的子集。

@GetMapping、@PostMapping、@PutMapping、@DeleteMapping 是 @RequestMapping 的子集。所以实际上我们只需要掌握 @Controller 和 @RequestMapping 就可以了。

1.3 @Controller 与 @RestController 区别

@Controller 包括了 @RestController。@RestController 是 Spring4后新加的注解，从 RestController类源码可以看出 @RestController 是 @Controller 和 @ResponseBody 两个注解的结合体。

@Controller=@RestController+@ResponseBody
如下 @RestController 的源码可以看出他们的关系

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

1.4 @Controller 与 @RestController应用场景

- @Controller 一般应用在有返回界面的应用场景下.

例如，管理后台使用了 thymeleaf 作为模板开发，需要从后台直接返回 Model 对象到前台，那么这时候就需要使用 `@Controller` 来注解。

  • @RestController如果只是接口，那么就用 @RestController 来注解.

    例如前端页面全部使用了 Html、Jquery 来开发，通过 Ajax 请求服务端接口，那么接口就使用 @RestController 统一注解。

1.5 @RequestMapping 说明

首先我们来看看 @RequestMapping 的源码,我在上面加了注释

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    //指定请求的实际地址
    @AliasFor("path")
    String[] value() default {};
    @AliasFor("value")
    String[] path() default {};
    //指定请求的method类型， GET、POST、PUT、DELETE等
    RequestMethod[] method() default {};
    //指定request中必须包含某些参数值是，才让该方法处理。
    String[] params() default {};
    //指定request中必须包含某些指定的header值，才能让该方法处理请求。
    String[] headers() default {};
    //指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
    String[] consumes() default {};
    //指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
    String[] produces() default {};
}

示例说明：

示例说明
@RequestMapping("/index")默认为 GET 方法的路由 /index
@RequestMapping(value="/index",method = RequestMethod.GET)同上面一条
@RequestMapping(value="/add",method = RequestMethod.POST)路由为 /add 的 POST 请求
@RequestMapping(value="/add",method = RequestMethod.POST),consumes=“application/json”路由为 /add 的 POST 请求，但仅仅处理 application/json 的请求
@RequestMapping(value="/add",method = RequestMethod.POST),produces=“application/json”路由为 /add 的 POST 请求，强调返回为 JSON 格式
@RequestMapping(value="/add",method = RequestMethod.POST),params=“myParam=xyz”路由为 /add 的 POST 请求，但仅仅处理头部包括 myParam=xyz 的请求
@RequestMapping(value="/add",method = RequestMethod.POST),headers=“Referer=http://www.xyz.com/”路由为 /add 的 POST 请求，但仅仅处理 来源为 www.xyz.com 的请求

2 @Controller 和 @RestController 示例

本章节，将对两个注解配合其他注解编写一系列示例，为了演示 @Controller返回对应页面功能，我们在示例中引入了 thymeleaf模板。具体在 pom.xml 中有说明。

编号路由Http方法方法说明
1/user/indexGET获取用户列表并返回列表页面
1/user/addGET用户新增页面
1/user/savePOST新增用户的api
1/user/editGET用户编辑的页面
1/user/updatePOST编辑用户的api
1/user/delGET删除用户页面
1/user/deletedPOST删除用户页面的api

2.1 新建 Spring Boot 项目

  1. File > New > Project，如下图选择 Spring Initializr 然后点击 【Next】下一步
  2. 填写 GroupId（包名）、Artifact（项目名） 即可。点击 下一步
    groupId=com.fishpro
    artifactId=restcontroller
  3. 选择依赖 Spring Web Starter 前面打钩,在模板列中勾选 thymeleaf。
  4. 项目名设置为 spring-boot-study-restcontroller.

2.2 依赖 Pom.xml 配置

本项目引入了 web 和 thymeleaf ，具体一人如下代码：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

并把配置文件重命名为 application.yml，修改默认测试端口

server:
  port: 8087

2.3 基于 @Controller 的示例代码

本代码实例中新增了如下页面，注意 templates 表示 /resources/tempalates/，controller 表示 com.fishpro.restcontroller.controller 包。

  • controller/UserController.java 控制层-用户类
  • domain/UserDO.java 用户控实体类
  • templates/user/index.html 视图-用户列表页面
  • templates/user/add.html 视图-新增用户页面
  • templates/user/edit.html 视图-编辑用户页面

2.3.1 返回用户列表信息 /user/index

本项目源码下载

首先构件一个虚拟的用户数据

  /**
     * 模拟一组数据
     * */
    private List<UserDO> getData(){
        List<UserDO> list=new ArrayList<>();

        UserDO userDO=new UserDO();
        userDO.setUserId(1);
        userDO.setUserName("admin");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(2);
        userDO.setUserName("heike");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(3);
        userDO.setUserName("tom");
        list.add(userDO);

        userDO=new UserDO();
        userDO.setUserId(4);
        userDO.setUserName("mac");
        list.add(userDO);

        return  list;
    }

1 创建一个用户列表页面 /user/index

UserController增加方法如下图所示，使用 @RequestMapping 注解，注意 @RequestMapping(method = RequestMethod.GET,value = "/index") 等于 @RequestMapping(value = "/index") 也等于 @RequestMapping("/index") 也等于 @GetMapping("/index")

 /**
     * GET  返回用户列表信息
     * */
    @RequestMapping(method = RequestMethod.GET,value = "/index")
    public String index(Model model){
        List<UserDO> list =getData();
        model.addAttribute("list",list);//返回 用户 list
        return "user/index";
    }

2 创建 templates/index.html 对应上面的路由 /user/index

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div class="title">

</div>
<div th:each="user :${list}">
    用户ID：<span th:text="${user.userId}"></span>
    用户名：<span th:text="${user.userName}"></span>
</div>
</body>
</html>

3 在浏览器中查看

右键 RestControllerApplication > Run 在浏览器输入 http://localhost:8087/user/index

用户ID：1 用户名：admin
用户ID：2 用户名：heike
用户ID：3 用户名：tom
用户ID：4 用户名：mac

2.3.3 新增用户页面 /user/add

本项目源码下载

在 UserController 中增加 add 路由 /user/add

UserController 增加方法如下图所示，使用 @RequestMapping 注解，并创建了两个路由

  • /user/add 对应前端页面
  • /user/save 对应前端页面提交按钮的接口
 /**
     * GET 返回add页面
     * @GetMapping("/add") = @RequestMapping(method = RequestMethod.GET,value = "/add")
     * */
    @GetMapping("/add")
    public String add(){
        return "user/add";
    }
    /**
     * POST 新增用户api
     * @return 返回 map对象
     * */
    @RequestMapping(method = RequestMethod.POST,value = "/save")
    @ResponseBody
    public Object save(UserDO user){
        List<UserDO> list= getData();
        list.add(user);//模拟向列表中增加数据
        Map<String,Object> map=new HashMap<>();
        if(null==user){

            map.put("status",3);
            map.put("message","没有传任何对象");
            return  map;
        }
        map.put("status",0);
        map.put("data",user);
        return  map;
    }

创建 templates/add.htm 文件对应路由 /user/add

在对应的 templates/add.html中增加代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>用户新增页面</title>
    <script src="https://cdn.bootcss.com/jquery/1.11.3/jquery.js"></script>
</head>
<body>
<form id="form1">
    <div> <input name="userId" id="userId"  placeholder="请输入userid"></div>
    <div> <input name="userName" id="userName"   placeholder="请输入username"></div>
    <div> <input  type="button" value="新增" id="btnSave"/></div>
</form>
<script>
    $(function () {

        $("#btnSave").click(function () {
            $.ajax({
                cache: true,
                type: "POST",
                url: "/user/save",
                data:$('#form1').serialize(),
                dataType:"json",
                async: false,
                error: function (request) {
                    console.log("Connection error");
                },
                success: function (data) {
                    if (data.code == 0) {
                        console.log("成功");
                    } else {
                        console.log("失败");
                    }

                }
            });
        });

    });
</script>
</body>
</html>

在浏览器中测试效果
右键 RestControllerApplication > Run 在浏览器输入 http://localhost:8087/user/add

2.3.3 编辑用户页面 /user/edit

这部分代码原理同 2.3.2 代码原理 通过构件一个编辑页面，点击编辑页面的【保存】提交到后端的 api 中。

本示例中创建了2个接口 1个文件

  • /user/edit 对应前端页面
  • /user/update 对应前端页面提交按钮的接口
  • /templates/user/edit.html
 /**
     * GET 返回编辑页面
     * @GetMapping("/edit/{id}") = @RequestMapping(method = RequestMethod.GET,value = "/edit/{id}")
     * @PathVariable("id") 表示路由中的动态参数部分
     * @param  id 表示要编辑的用户id
     * @param model 表示将要输出到页面的 Model 对象
     * @return 返回到 user/edit页面
     * */
    @GetMapping("/edit/{id}")
    public String edit(@PathVariable("id") String id, Model model){
        UserDO user =new UserDO();
        user.setUserId(3);
        user.setUserName("fishpro");
        model.addAttribute("user",user);
        return "user/edit";
    }

    /**
     * POST 修改用户api
     * @RequestBody 表示参数使用 json 对象传输
     * @return 返回 map对象
     * */
    @PostMapping("/update")
    @ResponseBody
    public Object update(@RequestBody UserDO user){
        Map<String,Object> map=new HashMap<>();
        if(null==user){

            map.put("status",3);
            map.put("message","没有传任何对象");
            return  map;
        }
        //更新逻辑
        map.put("status",0);
        return  map;
    }

edit.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>用户编辑页面</title>
    <script src="https://cdn.bootcss.com/jquery/1.11.3/jquery.js"></script>
</head>
<body>
<form id="form1">
    <div> <input name="userId" id="userId"  placeholder="请输入userid" th:value=${user.userId}> </div>
    <div> <input name="userName" id="userName"   placeholder="请输入username" th:value=${user.userName}></div>
    <div> <input  type="button" value="新增" id="btnSave"/></div>
</form>
<script>
    $(function () {

        $("#btnSave").click(function () {
            $.ajax({
                cache: true,
                type: "POST",
                url: "/user/update",
                data:$('#form1').serialize(),
                dataType:"json",
                async: false,
                error: function (request) {
                    console.log("Connection error");
                },
                success: function (data) {
                    if (data.code == 0) {
                        console.log("成功");
                    } else {
                        console.log("失败");
                    }
                }
            });
        });

    });
</script>
</body>
</html>

本项目源码下载

2.3.3 删除用户 /user/delete

本项目源码下载

/**
     * POST 修改用户api 
     * @return 返回 map对象
     * */
    @PostMapping("/delete/{id}")
    @ResponseBody
    public Object delete(@PathVariable("id") Integer id){
        List<UserDO> list= getData();
        UserDO userDO=null;
        for (UserDO user:list
                ) {
            if(id.equals(user.getUserId().toString())){
                //删除用户
                userDO=user;
                break;
            }
        }

        Map<String,Object> map=new HashMap<>();
        map.put("status",0);
        map.put("data",userDO);
        return  map;
    }

2.4 基于 @RestController 的示例代码

本章节中是基于 2.3版本中的接口，其实是一样的功能，详细见下面的代码，为了完成代码功能示例，我们新建了 UserRestController.java，不同的是 我们给类加了 @RestController 修饰符。

@RestController
@RequestMapping("user2")
public class UserRestController {
    //从 UserController 搬过来代码即可
}

本项目源码下载

关联阅读：

Spring Boot Thymeleaf 模板引擎的使用

Spring Boot RESTful api

Spring Boot Log 日志使用教程

Spring Boot 全局异常处理

fishpro
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot开发实战：基于Spring Boot的RESTful API服务的实验心得与案例解析
05-08
开发一个基于Spring Boot的RESTful API服务，该服务提供用户管理功能，包括用户的增删改查操作。Spring Boot的自动配置减少了繁琐的XML配置，通过条件化配置，使得开发者可以更加专注于业务逻辑的实现。通过起步依赖...
@RestController常见用法
OriSu
04-15 8373
@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。 Request Mapping 基础用法 下面是一个同时在类和方法上应用了 @RequestMapping 注解的示例： @RestController @RequestMapping("/home") public cl...
@RestController的使用
晚晴小筑
08-28 3300
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Controller @ResponseBody public @interface RestController { String value() default ""; }可以看到，该注解本身使用@Controller和@ResponseB
@Controller @RestController 使用教程
xsq123的专栏
06-19 1597
@Controller @RestController 使用教程
@RestController与@Controller 的用法 傻傻分不清？
IceStreamLab
03-21 617
文章目录一）、@RestController = @Controller + @ResponseBody二）、@Controller三）、@RestController与@Controller对比分析 一）、@RestController = @Controller + @ResponseBody /** * @author MoCha * @date 2019/3/21 */ @RestC...
Springboot同时提供webservice服务和Restful api接口
chengpazhixia65866的博客
05-13 4459
最近有个项目，既要对接现有的webservice服务，又要对外提供soap协议的webservice接口，还要提供Restful API接口供自身的前端界面调用。 因为最近一直使用springboot框架，所以依然沿用该框架。 静态文件位于 /src/main/resources/stat...
基于Spring Boot的Java后端开发基础教程设计源码
最新发布
05-22
Spring Boot Java后端开发基础教程：该项目基于Spring Boot，包含135个文件，主要使用Java和HTML语言。教程涵盖Spring Boot 2.0的基础知识，包括日志配置、数据源配置和事务管理等。适合初学者和希望深入了解Spring ...
Spring Boot技术知识点：如何使用@Validated注解来对邮箱字段进行数据校验
07-04
Spring Boot技术知识点：如何使用@Validated注解来对邮箱字段进行数据校验
Spring Boot中使用Swagger2构建强大的RESTful API文档
01-04
为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又...
关于HttpServletResponse与RestController
taylor的博客
08-17 1126
当调用response.getOutputStream()后一些有趣的事, 之后不管发生什么,body的数据只与调用outputStream.write(…)有关; 1.如果return null则一切正常,Content-Type不会被改为application/json;charset=UTF-8. 2.如果正常关闭了ServletOutputStream且之前设置了Content-Type不是application/json;charset=UTF-8,后有其他的 return XXX(非null),
SpringBoot总结【注解，项目配置，Controller，RESTful API，数据库操作，事务】
qq_42019366的博客
05-29 1424
1. 原理与优势 SpringBoot是一个便捷开发框架，能很好地将一些常用的第三方依赖整合（原理：通过Maven子父工程的方式），简化XML配置，全部采用注解形式，内置Http服务器（Tomcat），最终以java应用程序进行执行。 核心优势： 1>无配置文件（纯Java）完全注解化+ 2> SpringBoot核心快速整合第三方框架原理:Maven继承依赖关系。 SpringBoot的实现是由启动器和自动配置以及大量的注解来完成的。启动器是我们在pom文件中引入的依赖；自动配置是Spring
Restful接口开发（2）：RestController详解-基础
小蚯蚓的博客
09-04 3299
一、日志级别 使用commons.logging记录日志 1.日志级别 TRACE<DEBUG<INFO<WARN<ERROR<FATAL 2.配置文件..demo\src\main\resources\application.yml配置日志输出级别为TRACE spring: jackson: date-format: yyyy-MM-dd...
apicontroller实践
亮居
10-18 1849
webapi与postman调试
【软件开发架构平台】CH10 RESTful API的实现
May_mayw的博客
04-29 1141
请求和URL的重构 请求数据的获取 @RequestParam：获取URL中的查询参数值 @RequestBody：获取POST或PUT中对象的值 @PathVariable：获取URL中的参数值 参数校验 @Valid注解和@Validation注解 @Validation注解是SpringFramework中提供的验证机制，是JSR-303规范的一个变种，可以使用在类型、方法和方法参数上，但不能使用在类的成员属性上 @Valid注解是Hibernate框架提供的验证机制，符合JSR-303标准，
接口开发相关知识点？@RestController注解和@Api注解是什么意思？有什么用？
qq_20446879的博客
08-27 5180
@RestController注解是什么意思？有什么用？ @RestController注解是一个组合注解，相当于@Controller注解和@ResponseBody注解的组合，在该Controller类中的所有方法都默认添加了@ResponseBody注解，同时声明该类是一个Controller类。@RestController注解用于类上，不用于方法上。 @Api()注解是什...
Spring Boot Xml 使用 Dom4j XStream 操作 Xml
fishpro的博客
03-18 2403
Spring Boot Xml 使用 Dom4j XStream 操作 Xml0 Dom4j XStream 简单介绍Dom4jXStream1 新建 Spring Boot Maven 示例工程项目2 引入依赖 Pom3 Dom4j 代码实例3.1 打开一个远程 xml3.2 创建一个 xml 文档3.3 遍历3.4 使用 xpath 获取节点3.5 保存到 文件3.6 XML 文件转文本3.7...
Spring Boot 整合 Email 电子邮件教程
fishpro的博客
03-17 1961
Spring Boot 整合 Email 电子邮件教程1 新建 Spring Boot Maven 示例工程项目2 引入依赖 Pom3 配置邮件信息4 编写示例代码4.1 发送文本邮件4.2 发送邮件内容为 Html 的邮件4.3 发送带有附件的邮件4.4 发送带静态资源的邮件4.5 发送基于 freemarker 模板内容的邮件 Spring Boot使用 JavaMailSender 来发送邮...
Spring Boot 整合 Shiro 快速入门
fishpro的博客
03-16 1567
Spring Boot 整合 Shiro 快速入门1 Spring Boot 快速集成 Shiro 示例1.1 新建 Spring Boot Maven 示例工程项目1.2 依赖引入 Pom.xml1.3 配置 application.yml1.4 自定义 Realm 领域 UserRealm 实现自定义认证与授权1.6 shiro 实现登录认证1.6.1 登录 html 页面1.6.2 登录逻辑...
Spring Boot 配置文件的配置与获取值
fishpro的博客
03-14 1525
Spring Boot 配置文件的配置与获取值1 bootstrap1.1 bootstrap 应用场景1.2 bootstrap 与 application2 application2.1 application 常用配配置2.1.1 端口配置2.1.2 thymeleaf组件配置2.1.3 数据库连接配置2.1.4 数据持久化2.1.5 多种开发环境2.2 如何获取 application 中...
spring boot restful api开发
04-29
Spring Boot是一个快速开发框架，可以帮助我们快速构建RESTful API。下面是一个简单的Spring Boot RESTful API开发的步骤： 1. 创建一个Maven项目并添加Spring Boot依赖 ```xml <groupId>org.springframework....

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值