@Controller是SpringBoot里最基本的组件,他的作用是把用户提交来的请求通过对URL的匹配,分配个不同的接收器,再进行处理,然后向用户返回结果。下面通过本文给大家介绍Spring Boot中@Controller用法,使用方法如下:
@Controller的作用,就是在于如何从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) {
/*这里的index等于index.html,只是这样写为方便,返回值为字符型*/
return "index";
}
}
首先应该在类的开头,加上@Controller注解,告知Spring这是一个控制器。
二 @ResponseMapping的使用方法,如下所示:
然后在对应的处理函数前面加上@RequestMapping,告知这个函数需要相应的URL。接着这个函数传入了一个Model类型的参数,这个参数主要是用于向模板传递数据(输出数据,我的理解是否有误,还有大家点指)。该函数最后返回了一个名为”index”的字符串,表示将调用名为”index”的模板,具体名称取决于模板引擎。
如果是jsp模板,他将访问”index.jsp”这个文件,
如果是thymeleaf模板,他将访问”index.html”这个文件;原因如下
序号 | thymeleaf模板规则 |
1 | thymeleaf默认配置的视图解析器的前缀下图示 内容: classpath:/templates classpath:/templates |
2 | thymeleaf默认配置的视图解析器的后缀下图所示 模板的默认后缀名为: |
3 | 而自己写的html页面(thymeleaf)都放在resources文件夹下面的templates目录下,因此我们无需配置视图解析器 |
三 @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";
}
}
Path Variable RequestMapping中的path也可以是一个未定的变量,比如下面的代码:
@Controller
public class TestController {
@RequestMapping("/{variable}")
@ResponseBody
public String index(@PathVariable("variable")String variable) {
return variable;
}
}
通过花括号我们就可以指定这个变量,并且通过@PathVariable注解得到这个参数,非常方便。RequestParamRequestMapping也可以获取类似表单传回的信息形式,比如/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;
}
}
我们可以控制这个参数的名字,是否必须,以及设置默认值,来更好的进行匹配。RequestBodyRequestBody用来获取Post信息的消息体,只要在参数中通过@RequestBody注解就能得到这个参数:
@Controller
public class TestController {
@RequestMapping("/index")
@ResponseBody
public String index(@RequestBody String body) {
//对body进行解析即可
return "success";
}
}