SpringBoot中的Controller用法示例详解

更新时间：2023年06月25日 15:34:22 作者：苹果牛顿吃

Controller是SpringBoot里最基本的组件，他的作用是把用户提交来的请求通过对URL的匹配，分配给不同的接收器，再进行处理，然后向用户返回结果，这篇文章主要介绍了SpringBoot中的Controller用法,需要的朋友可以参考下

Controller

Controller是SpringBoot里最基本的组件，他的作用是把用户提交来的请求通过对URL的匹配，分配给不同的接收器，再进行处理，然后向用户返回结果。他的重点就在于如何从HTTP请求中获得信息，提取参数，并分发给不同的处理服务。

基本组成

一个最经典的Controller应该大概长这样:

package com.example.demo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
/**
 * Created by myths on 5/16/17.
 */
@Controller
public class IndexController {
    @RequestMapping(value = {"index", "/"})
    public String index(Model model) {
        return "index";
    }
}

复制

首先应该在类的开头，加上@Controller注解，告知Spring这是一个控制器。然后在对应的处理函数前面加上@RequestMapping，告知这个函数需要相应的URL。接着这个函数传入了一个Model类型的参数，这个参数主要是用于向模板传递数据。该函数最后返回了一个叫"index"的字符串，表示将调用名为"index"的模板，具体名称取决于模板引擎，比如对于jsp他将访问"index.jsp"这个文件,对于thymeleaf，他将访问"index.html"这个文件。

上面的是最简单的用法，实际上有很多细节需要注意，下面就来一一解释。

ResponseBody

如果我们想返回纯字符串而不是渲染后的模板，那我们可以在需要返回字符串的函数前面加上@ResponseBody这个注解；如果我们像对于整个类都返回字符串，我们也可以在这个类前面加上@ResponseBody注解，或者将@Controller注解换成@RestController，均可。

RequestMapping 基本用法

这个注解是用来告诉Spring，下面的这个函数或者类是用来映射到那个URL的，通常情况下有下面这些选项：

    @RequestMapping(
            path = {"/test"},
            params = {"name","userId"},
            method = {RequestMethod.GET},
            consumes = {"text/plain", "application/*"},
            produces = "text/plain",
            headers = "content-type=text/*"
    )

复制

我们可以指定这个路径，参数，方法，头信息，来作为一个Controller的入口。当然，通常我们只需要指定path就行了。

对象转json或xml

这里有一个使用的小窍门，比如有时候我们希望返回json字符串，我们当然可以调用jackson,gson,fastjson等等工具来组合数据，但是这样显然比较麻烦。其实springboot自带了将对象持久化的工具，只要我们在produces参数中指定头信息，就可以将返回的对象直接转换为json或xml。比如:

package com.mythsman.controller;
import com.mythsman.bean.TestBean;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestController {
    @RequestMapping(value = "test", produces = {"application/json;charset=UTF-8"})
    public TestBean test() {
        TestBean testBean = new TestBean();
        testBean.setName("myths");
        testBean.setAge(12);
        return testBean;
    }
}

复制

访问后的返回结果就是{"name":"myths","age":12}。同理，也可以自动转换成xml格式，不过xml格式对与map等的数据结构无法支持，因此我们还是建议采用json。

作用对象

这个注解可以注解一个函数，也可以注解一个类。当注解一个类时，类中所有的方法都会在这个基础上再进行过滤：

@Controller
@RequestMapping("/path1")
public class TestController {
    @RequestMapping("/path2")
    @ResponseBody
    public String index() {
        return "ok";
    }
}

复制

这个函数就能匹配"/path1/path1"这个地址。

缺省参数

当RequestMapping的参数是空的时候，他就表示匹配剩余所有的页面,实际上也就是匹配所有的404页面。

@Controller
public class IndexController {
    @RequestMapping
    public String index(Model model) {
        return "index";
    }
}

复制

当RequestMapping不指定参数名时，默认就是path参数。

@Controller
public class IndexController {
    @RequestMapping("/index")
    public String index(Model model) {
        return "index";
    }
}

复制

PathVariable

RequestMapping中的path也可以是一个未定的变量，比如下面的代码:

@Controller
public class TestController {
    @RequestMapping("/{variable}")
    @ResponseBody
    public String index(@PathVariable("variable")String variable) {
        return variable;
    }
}

复制

通过花括号我们就可以指定这个变量，并且通过@PathVariable注解得到这个参数，非常方便。

RequestParam

RequestMapping也可以获取类似表单传回的信息形式，比如/index?name=XXX，这个name变量就可以通过RequestParam注解来获得:

@Controller
public class TestController {
    @RequestMapping("/index")
    @ResponseBody
    public String index(@RequestParam(value = "name",required = false,defaultValue = "233")String name) {
        return name;
    }
}

复制

我们可以控制这个参数的名字，是否必须，以及设置默认值，来更好的进行匹配。

RequestBody

RequestBody用来获取Post信息的消息体,只要在参数中通过@RequestBody注解就能得到这个参数:

@Controller
public class TestController {
    @RequestMapping("/index")
    @ResponseBody
    public String index(@RequestBody String body) {
		//对body进行解析即可
        return "success";
    }
}

到此这篇关于SpringBoot中的Controller用法的文章就介绍到这了,更多相关SpringBoot Controller用法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java爬虫范例之使用Htmlunit爬取学校教务网课程表信息
htmlunit 是一款开源的java 页面分析工具，读取页面后，可以有效的使用htmlunit分析页面上的内容。项目可以模拟浏览器运行，被誉为java浏览器的开源实现。今天我们用这款分析工具来爬取学校教务网课程表信息
2021-11-11
Springmvc数据回显实现原理实例解析
这篇文章主要介绍了Springmvc数据回显实现原理实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-09-09
SpringBoot整合Mockito进行单元测试实践
本文介绍了Spring Boot结合JUnit5和Mockito进行单元测试的方法,涵盖环境准备、核心概念、实战案例、高级用法、覆盖率工具等内容,同时提供了常见问题解决方案和测试原则建议,帮助读者全面掌握测试技巧,编写高效可靠的测试代码
2026-05-05
idea修改language level版本实现方式
文章介绍了在不同版本JDK之间的切换时遇到的语言级别版本问题的解决方案,通过修改系统环境变量、Maven配置和IDEA设置,可以实现不同JDK版本的切换,并确保项目顺利编译和运行
2025-12-12
Java可以写android的应用程序吗
在本篇文章里小编给大家整理的是一篇关于Java可以写android的应用程序吗的相关基础文章，有兴趣的朋友们可以学习下。
2020-11-11
Spring Boot线程池使用的一些实用心得
理论上线程越多程序可能更快,但在实际使用中我们需要考虑到线程本身的创建以及销毁的资源消耗,以及保护操作系统本身的目的我们通常需要将线程限制在一定的范围之类,这篇文章主要给大家介绍了关于Spring Boot线程池使用的一些实用心得,需要的朋友可以参考下
2021-09-09
支付宝APP支付（IOS手机端+java后台）版
这篇文章主要为大家详细介绍了支付宝APP支付（IOS手机端+java后台）版，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-05-05
MyBatis常见报错问题及解决方案
这篇文章主要介绍了MyBatis常见报错问题及解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
Java之SpringBoot-Thymeleaf详情
聊Thymeleaf，需要知道为什么到了SpringBoot中就不用JSP了？这跟SpringBoot打包方式有点关系，SpringBoot项目打包是jar包，下面文章小编就对此做一个详细介绍,需要的朋友可以参考一下
2021-09-09
Java中自定义类的实现详解
自定义类是Java中最基本、也是最重要的组成部分之一，使用者可以根据需求创建自己的数据类型，从而更加高效地构建程序，本文就来为大家详细讲讲Java中自定义类的实现与使用吧
2023-05-05