详解Spring Boot中Controller用法

 更新时间:2017年05月21日 18:02:00   作者:Myths  
Controller是SpringBoot里最基本的组件,他的作用是把用户提交来的请求通过对URL的匹配,分配个不同的接收器,再进行处理,然后向用户返回结果。下面通过本文给大家介绍Spring Boot中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就行了。

作用对象

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

@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";
  }
}

总结

上面这些大概就是Controller中最基本的用法了,十分的方便清楚。具体的细节可以参考源码中的注释,解释的也是十分详尽了。

以上所述是小编给大家介绍的Spring Boot中Controller用法,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的,在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • Java多线程中的ThreadLocal应用场景及问题解读

    Java多线程中的ThreadLocal应用场景及问题解读

    这篇文章主要介绍了Java多线程中的ThreadLocal应用场景及问题解读,ThreadLocal这个类在多线程并发中主要的使用场景是什么呢,我们都知道多线程并发问题实际就是多个线程对公共资源访问和修改问题,需要的朋友可以参考下
    2023-12-12
  • Spring Date jpa 获取最新一条数据的实例代码

    Spring Date jpa 获取最新一条数据的实例代码

    这篇文章主要介绍了Spring Date jpa 获取最新一条数据的实例代码,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • java爬取并下载酷狗TOP500歌曲的方法

    java爬取并下载酷狗TOP500歌曲的方法

    这篇文章主要介绍了java爬取并下载酷狗TOP500歌曲的方法,非常具有实用价值,需要的朋友可以参考下
    2019-01-01
  • SpringBoot环境Druid数据源使用及特点

    SpringBoot环境Druid数据源使用及特点

    Druid 是目前比较流行的高性能的,分布式列存储的OLAP框架(具体来说是MOLAP)。本文给大家分享SpringBoot环境Druid数据源使用及特点介绍,感兴趣的朋友跟随小编一起看看吧
    2021-07-07
  • json-lib将json格式的字符串,转化为java对象的实例

    json-lib将json格式的字符串,转化为java对象的实例

    下面小编就为大家带来一篇json-lib将json格式的字符串,转化为java对象的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • 解析Java的JVM以及类与对象的概念

    解析Java的JVM以及类与对象的概念

    这篇文章主要介绍了解析Java的JVM以及类与对象的概念,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09
  • 详解Spring基于xml的两种依赖注入方式

    详解Spring基于xml的两种依赖注入方式

    这篇文章主要介绍了详解Spring基于xml的两种依赖注入方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • java并发分段锁实践代码

    java并发分段锁实践代码

    这篇文章主要介绍了java并发分段锁实践代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • Java String对象使用方法详解

    Java String对象使用方法详解

    这篇文章主要介绍了Java String对象使用方法详解的相关资料,需要的朋友可以参考下
    2017-04-04
  • springboot配置mysql连接的实例代码

    springboot配置mysql连接的实例代码

    这篇文章主要介绍了springboot配置mysql连接的实例代码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01

最新评论