概述
在Spring Boot应用中，Controller是负责处理Web请求和响应的核心组件之一。它充当了应用程序的入口点，将来自前端的请求映射到相应的业务逻辑处理，并返回适当的响应。本篇技术长博文将深入探讨Spring Boot中的Controller控制器的作用、用法和最佳实践，并通过代码示例演示如何构建和使用Controller来实现灵活的Web请求处理。
1. Controller基本概念
Controller是Spring MVC框架的一部分，用于处理来自客户端的HTTP请求，并将其映射到相应的处理方法。Controller的主要目标是将Web请求与应用程序的业务逻辑分离，从而提高代码的可维护性和扩展性。
SpringBoot 提供了两种@controller和@restController注解负责接收处理HTTP请求
@Controller
请求页面
前端${name}接收后端数据
通常与Thymeleaf模板引擎配合使用
@RestController
请求数据
对象数据转Json数据
2. 创建一个简单的Controller
步骤1：创建Spring Boot项目
在IDE中创建一个新的Spring Boot项目，确保已包含Web依赖。
步骤2：编写Controller类
@RestController
public class HelloWorldController {
@GetMapping("/hello")
public String hello() {
return "Hello, Spring Boot!";
}
}
步骤3：运行应用
运行Spring Boot应用并访问http://localhost:8080/hello，将看到页面上显示"Hello, Spring Boot!"。
3. Controller的请求映射
Controller可以使用不同的注解来映射不同类型的请求，如@GetMapping、@PostMapping、@PutMapping和@DeleteMapping等。通过这些注解，你可以将请求映射到相应的处理方法。
@RestController
public class UserController {
@GetMapping("/users")
public List<User> getAllUsers() {
// 从数据库或其他数据源获取用户列表
List<User> users = userRepository.getAllUsers();
return users;
}
@PostMapping("/users")
public User createUser(@RequestBody User user) {
// 创建新用户并保存到数据库
User newUser = userRepository.createUser(user);
return newUser;
}
}
4. 请求参数和路径变量
Controller方法可以接受请求参数和路径变量，从而根据不同的参数值执行不同的逻辑。
@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
// 根据用户ID从数据库获取用户信息
User user = userRepository.getUserById(id);
return user;
}
@GetMapping("/greet")
public String greet(@RequestParam(name = "name", defaultValue = "Guest") String name) {
return "Hello, " + name + "!";
}
5. 返回数据与视图
Controller方法可以返回不同类型的数据，如字符串、JSON、视图模板等。
@GetMapping("/message")
public String getMessage() {
return "Welcome to our website!";
}
@GetMapping("/user/{id}")
public ResponseEntity<User> getUser(@PathVariable Long id) {
User user = userRepository.getUserById(id);
if (user != null) {
return ResponseEntity.ok(user);
} else {
return ResponseEntity.notFound().build();
}
}
@GetMapping("/view")
public ModelAndView getView() {
ModelAndView modelAndView = new ModelAndView("myView");
modelAndView.addObject("message", "Hello from the view!");
return modelAndView;
}
重点
路由映射
@RequestMapping注解负责URL路由映射
作用域：类或方法
value：请求URL路径
method：HTTP请求方法
consumes:请求的媒体类型（application/json)
produces:响应的媒体类型
params,headers:请求的参数及请求头的值
@RequestMapping（value=“getUser”，method=RequestMethod.GET）
@RequestMapping
@RequestMapping（“/getJson/*.json”）
/getJson/x.json、/getJson/y.json
“*”匹配任意字符（优先级高）
“**”匹配任意路径（优先级低）
“？”匹配单个字符
Method匹配
HTTP请求Method：GET、POST、PUT、DELETE等
@GetMapping、@PostMapping等
参数传递
@RequestParam
绑定在方法参数上
当请求参数名与Controller的业务方法名称一致时@RequestParam可省略
@RequestParam("nikename")String name
@PathVaraible
用来处理动态的URL、URL的值可以作为控制器中处理方法的参数
@GetMapping("/api/{id}")
public String api(@PathVaraible int id)
@RequestBody
请求体
application/json、application/xml
总结
Spring Boot的Controller控制器是实现Web请求处理与业务逻辑分离的关键组件。通过本文的介绍和示例，你已经了解了如何创建和配置Controller，并使用各种注解来映射不同类型的请求。此外，你还学会了如何处理请求参数和路径变量，以及如何返回不同类型的数据和视图。通过合理地设计和使用Controller，你可以构建出灵活、高效的Spring Boot应用，提供出色的Web服务和用户体验。
