详解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中的自旋锁spinlock详解

    Java中的自旋锁spinlock详解

    这篇文章主要介绍了Java中的自旋锁spinlock详解,自旋锁就是循环尝试获取锁,不会放弃CPU时间片,减伤cup上下文切换,缺点是循环会消耗cpu,需要的朋友可以参考下
    2024-01-01
  • java 代理模式及动态代理机制深入分析

    java 代理模式及动态代理机制深入分析

    这篇文章主要介绍了java 代理模式及动态代理机制深入分析的相关资料, 代理是一种常用的设计模式,其目的就是为其他对象提供一个代理以控制对某个对象的访问,需要的朋友可以参考下
    2017-03-03
  • 2020年支持java8的Java反编译工具汇总(推荐)

    2020年支持java8的Java反编译工具汇总(推荐)

    这篇文章主要介绍了2020年支持java8的Java反编译工具汇总,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 详解MyBatis直接执行SQL查询及数据批量插入

    详解MyBatis直接执行SQL查询及数据批量插入

    这篇文章主要介绍了MyBatis直接执行SQL查询及数据批量插入的相关知识,需要的朋友一起学习吧
    2016-01-01
  • 可视化定时任务quartz集成解析全过程

    可视化定时任务quartz集成解析全过程

    在开发中有很多定时任务都不是写死的而是可以人为配置并且写到数据库中的,下面这篇文章主要给大家介绍了关于可视化定时任务quartz集成解析的相关资料,需要的朋友可以参考下
    2022-10-10
  • java简单实现斗地主发牌功能

    java简单实现斗地主发牌功能

    这篇文章主要为大家详细介绍了java简单实现斗地主发牌功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • PHP Laravel实现文件下载功能

    PHP Laravel实现文件下载功能

    本文重点给大家介绍Laravel实现文件下载功能的实例代码,需要的朋友参考下吧
    2017-09-09
  • IntelliJ IDEA下SpringBoot如何指定某一个配置文件启动项目

    IntelliJ IDEA下SpringBoot如何指定某一个配置文件启动项目

    这篇文章主要介绍了IntelliJ IDEA下SpringBoot如何指定某一个配置文件启动项目问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • Mybatis实体类对象入参查询的笔记

    Mybatis实体类对象入参查询的笔记

    这篇文章主要介绍了Mybatis实体类对象入参查询的笔记,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Java使用keySet方法获取Map集合中的元素

    Java使用keySet方法获取Map集合中的元素

    这篇文章主要为大家详细介绍了Java使用keySet方法获取Map集合中的元素,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-08-08

最新评论