Spring MVC控制器的14个小窍门（重点！要考！）
luojinbai 2019-12-17
在本文中，我将分享一些使用Spring MVC框架编写控制器类的基本技术和最佳实践。大佬认证，童叟无欺。小一万文字，建议点赞收藏，反复观看。
通常，在Spring MVC中，我们编写一个控制器类来处理来自客户端的请求。然后，控制器调用业务类来处理与业务相关的任务，然后将客户端重定向到逻辑视图名称，该名称由Spring的调度程序Servlet解析，以呈现结果或输出。这样就完成了典型的请求-响应周期的往返。
一。使用@Controller原型
这是创建可以处理一个或多个请求的控制器类的最简单方法。只需用@Controller构造型注释一个类，例如：
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HomeController {
@RequestMapping("/")
public String visitHome() {
//在返回视图名称之前做点啥
return "home";
}
}如您所见，visitHome（）方法通过重定向到名为home的视图来处理到达应用程序上下文路径（/）的请求。
注意：@Controller原型只能在Spring的配置文件中启用注释驱动时使用：
<annotation-driven />
启用注释驱动时，Spring容器会自动扫描以下语句中指定包下的类：
< context：component-scan base-package = “ net.codejava.spring” />
@Controller注释所注释的类被配置为控制器。这是最可取的，因为它很简单：不需要在配置文件中为控制器声明bean。
注意：通过使用@Controller注释，您可以拥有一个多操作控制器类，该类能够服务多个不同的请求。例如：
@Controller
public class MultiActionController {
@RequestMapping("/listUsers")
public ModelAndView listUsers() {
}
@RequestMapping("/saveUser")
public ModelAndView saveUser(User user) {
}
@RequestMapping("/deleteUser")
public ModelAndView deleteUser(User user) {
}
}正如上面的控制器类中看到的，有三个处理程序方法分别处理三个不同的请求/listUsers、/saveUser和/deleteUser。
2。实现控制器接口
在Spring MVC中创建控制器的另一种（可能也是经典的）方法是让一个类实现控制器接口。例如：
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
public class MainController implements Controller {
@Override
public ModelAndView handleRequest(HttpServletRequest request,
HttpServletResponse response) throws Exception {
System.out.println("Welcome main");
return new ModelAndView("main");
}
}实现类必须重写该 handleRequest() 方法，当匹配请求进入时，该方法将由Spring调度程序Servlet调用。此控制器处理的请求URL模式在Spring的上下文配置文件中定义如下：
<bean name="/main" class="net.codejava.spring.MainController" />
但是，此方法的缺点是控制器类无法处理多个请求URL。
3.扩展AbstractController类
如果要轻松控制受支持的HTTP方法，会话和内容缓存。你就要扩展AbstractController类。可以考虑以下示例：
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.AbstractController;
public class BigController extends AbstractController {
@Override
protected ModelAndView handleRequestInternal(HttpServletRequest request,
HttpServletResponse response) throws Exception {
System.out.println("You're big!");
return new ModelAndView("big");
}
}这将创建一个动作控制器，其中包含有关支持的方法、会话和缓存的配置，然后可以在控制器的bean声明中指定这些配置。例如：
<bean name="/big" class="net.codejava.spring.BigController">
<property name="supportedMethods" value="POST"/>
</bean>此配置指示此控制器的hander方法仅支持POST方法。有关其他配置（会话、缓存），请参见抽象控制器。
Spring MVC还提供了几个为特定目的而设计的控制器类，包括：
- AbstractUrlViewController（抽象视图控制器）
- MultiActionController（多动作控制器）
- ParameterizableViewController（参数化视图控制器）
- ServletForwardingController（服务转发控制器）
- ServletWrappingController服务器
- UrlFilenameViewController
4.为处理程序方法指定URL映射
这是编码控制器类时必须执行的强制性任务，该控制器类旨在处理一个或多个特定请求。Spring MVC提供了@RequestMapping 注释，该注释用于指定URL映射。例如：
@RequestMapping("/login")
映射要由带注释的方法或类处理的URL模式/登录。当在类级别使用此注释时，类将成为单个操作控制器。例如：
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
@RequestMapping("/hello")
public class SingleActionController {
@RequestMapping(method = RequestMethod.GET)
public String sayHello() {
return "hello";
}
}在方法级别使用@RequestMapping注释时，可以有一个多动作控制器。例如：
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class UserController {
@RequestMapping("/listUsers")
public String listUsers() {
return "ListUsers";
}
@RequestMapping("/saveUser")
public String saveUser() {
return "EditUser";
}
@RequestMapping("/deleteUser")
public String deleteUser() {
return "DeleteUser";
}
}的 @RequestMapping 注释也可用于指定多个URL模式由单个方法来处理。例如：
@RequestMapping({"/hello", "/hi", "/greetings"})此外，此注释还具有在某些情况下可能有用的其他属性。
5.为处理程序方法指定HTTP请求方法
可以使用@RequestMapping注释的method属性指定处理程序方法支持哪个HTTP方法（GET、POST、PUT…）。下面是一个例子：
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
public class LoginController {
@RequestMapping(value = "/login", method = RequestMethod.GET)
public String viewLogin() {
return "LoginForm";
}
@RequestMapping(value = "/login", method = RequestMethod.POST)
public String doLogin() {
return "Home";
}
}此控制器有两个处理相同URL模式的方法/登录，但前者用于GET方法，而后者用于POST方法。
6.将请求参数映射到处理程序方法
Spring MVC的很酷的功能之一是，可以使用@RequestParam 注释将请求参数作为处理程序方法的常规参数进行检索 。这是将控制器HttpServletRequest 与Servlet API 的接口分离的好方法 。
让我们看各种例子。请考虑以下方法：
@RequestMapping(value = "/login", method = RequestMethod.POST)
public String doLogin(@RequestParam String username,
@RequestParam String password) {
}Spring将方法参数用户名和密码绑定到具有相同名称的HTTP请求参数。这意味着可以按以下方式调用URL（如果请求方法是GET）：
http：// localhost：8080 / spring / login？username = scott＆password = tiger
类型转换也会自动完成。例如，按如下方式声明整数类型的参数：
@RequestParam int securityNumber
然后，Spring将在处理程序方法中自动将请求参数（字符串）的值转换为指定的类型（整数）。
如果参数名称与变量名称不同，则可以如下指定参数的实际名称：
@RequestParam("SSN") int securityNumber
该@RequestParam 注释也有两个额外的属性，这可能是在某些情况下是有用的。该属性指定参数是否为必需。例如：
@RequestParam(required = false) String country
这意味着该参数country是可选的；因此，它可能会从请求中丢失。在上面的示例中，country 如果请求中不存在此类参数，则变量将为null。
另一个属性是 defaultValue，可以在请求参数为空时用作后备值。例如：
@RequestParam(defaultValue = "18") int age
如果方法参数是Map<String，String>类型，Spring还允许我们作为Map对象访问所有参数。例如：
doLogin(@RequestParam Map<String, String> params)
然后，映射参数包含键-值对形式的所有请求参数。
7.返回模型和视图
处理完业务逻辑之后，处理程序方法应该返回一个视图，然后由Spring的dispatcher servlet解析该视图。Spring允许我们从handler方法返回字符串或ModelAndView对象。在以下示例中，handler方法返回一个字符串并表示一个名为LoginForm的视图：
@RequestMapping(value = "/login", method = RequestMethod.GET)
public String viewLogin() {
return "LoginForm";
}这是返回视图名称的最简单方法。但是，如果要将其他数据发送到视图，则必须返回ModelAndView对象。考虑以下处理程序方法：
@RequestMapping("/listUsers")
public ModelAndView listUsers() {
List<User> listUser = new ArrayList<>();
//从DAO获取用户列表...
ModelAndView modelView = new ModelAndView("UserList");
modelView.addObject("listUser", listUser);
return modelView;
}如您所见，此处理程序方法返回一个ModelAndView对象，该对象包含视图名称UserList和一组用户对象，这些对象可以在视图中使用。
Spring也是非常灵活的，因为您可以将MaldANDVIEW对象声明为处理程序方法的参数，而不是创建新方法。因此，上面的例子可以重写如下：
@RequestMapping("/listUsers")
public ModelAndView listUsers(ModelAndView modelView) {
List<User> listUser = new ArrayList<>();
//从DAO获取用户列表...
modelView.setViewName("UserList");
modelView.addObject("listUser", listUser);
return modelView;
}8.将对象放入模型
在遵循MVC架构的应用程序中，控制器（C）应该将数据传递到模型（M）中，然后在视图（V）中使用该模型。正如我们在前面的示例中看到的那样， 该类的addObject() 方法 ModelAndView是以名称-值对的形式将对象放入模型中：
modelView.addObject("listUser", listUser); modelView.addObject("siteName", new String("CodeJava.net")); modelView.addObject("users", 1200000);
同样，Spring非常灵活。可以在handler方法中声明Map类型的参数；Spring使用此映射存储模型的对象。让我们看另一个例子：
@RequestMapping(method = RequestMethod.GET)
public String viewStats(Map<String, Object> model) {
model.put("siteName", "CodeJava.net");
model.put("pageviews", 320000);
return "Stats";
}这比使用ModelAndView对象还要简单 。根据您的喜好，可以使用Map或使用ModelAndView 对象。
9.处理程序方法中的重定向
如果你希望在满足条件的情况下将用户重定向到另一个URL，只需在URL之前追加redirect:。下面的代码片段给出了一个示例：
//检查登录状态...
if (!isLogin) {
return new ModelAndView("redirect:/login");
}
//返回用户列表在上面的代码中，/login如果未登录，用户将被重定向到该URL。
10.处理表格提交和表格验证
通过提供@modeltattribute注释（用于将表单字段绑定到表单备份对象）和BindingResult接口（用于验证表单字段）来简化表单提交。以下代码段显示了负责处理和验证表单数据的典型处理程序方法：
@Controller
public class RegistrationController {
@RequestMapping(value = "/doRegister", method = RequestMethod.POST)
public String doRegister(
@ModelAttribute("userForm") User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
//表单验证错误
} else {
//表单输入正常
}
//处理注册...
return "Success";
}
}11.处理文件上传
Spring还可以通过自动将上传数据绑定到commonmultipartfile对象数组，在handler方法中轻松处理文件上传。Spring使用Apache Commons FileUpload作为底层的多部分解析器。
以下代码段显示了从客户端上载文件是多么easy，妈妈再也不用担心我的学习：
@RequestMapping(value = "/uploadFiles", method = RequestMethod.POST)
public String handleFileUpload(
@RequestParam CommonsMultipartFile[] fileUpload) throws Exception {
for (CommonsMultipartFile aFile : fileUpload){
//存储上传的文件
aFile.transferTo(new File(aFile.getOriginalFilename()));
}
return "Success";
}12.在控制器中自动装配业务类
控制器应将业务逻辑的处理委托给相关的业务类。为此，您可以使用@Autowired 批注让Spring自动将业务类的实际实现注入控制器。考虑以下控制器类的代码段：
@Controller
public class UserController {
@Autowired
private UserDAO userDAO;
public String listUser() {
//处理程序方法以列出所有用户
userDAO.list();
}
public String saveUser(User user) {
//保存/更新用户的处理程序方法
userDAO.save(user);
}
public String deleteUser(User user) {
//删除用户的处理程序方法
userDAO.delete(user);
}
public String getUser(int userId) {
//获取用户的处理程序方法
userDAO.get(userId);
}
}在此，与用户管理有关的所有业务逻辑都由该UserDAO接口的实现提供 。例如：
interface UserDAO {
List<User> list();
void save(User user);
void checkLogin(User user);
}通过使用@Autowired注释，处理程序方法可以将任务委托给业务类，如上例所示：
List<User> listUser = userDAO.list();
13.访问HttpServletRequest和HttpServletResponse
在某些情况下，需要在处理程序方法中直接访问HttpServletRequest或HttpServletResponse对象。通过Spring的灵活性，只需将相关参数添加到处理程序方法中即可。例如：
@RequestMapping("/download")
public String doDownloadFile(
HttpServletRequest request, HttpServletResponse response) {
//访问请求
//访问响应
return "DownloadPage";
}Spring检测并自动将HttpServletRequest和HttpServletResponse对象注入该方法。然后，你就可以访问请求和响应，例如获取InputStream、OutputStream或返回特定的HTTP代码。
14.遵循单一责任原则
最后，在Spring MVC中设计和编码控制器时，应遵循两个良好实践：
- 控制器类不应执行业务逻辑。相反，它应该将业务处理委托给相关的业务类别。这使控制器始终专注于其设计职责是控制应用程序的工作流程。例如：
@Controller
public class UserController {
@Autowired
private UserDAO userDAO;
public String listUser() {
//处理程序方法以列出所有用户
userDAO.list();
}
public String saveUser(User user) {
//保存/更新用户的处理程序方法
userDAO.save(user);
}
public String deleteUser(User user) {
//删除用户的处理程序方法
userDAO.delete(user);
}
public String getUser(int userId) {
//获取用户的处理程序方法
userDAO.get(userId);
}
}为每个业务域创建每个单独的控制器。例如，用于控制用户管理工作流的UserController、用于控制订单处理工作流的OrderController等。例如：
@Controller
public class UserController {
}
@Controller
public class ProductController {
}
@Controller
public class OrderController {
}
@Controller
public class PaymentController {
}这十四个技巧文字就有小一万，相信能帮你们正确有效的崽Spring MVC中编写控制器类。但是，一千个读者就有一千个哈姆雷特，如果你有其他好的建议，可以直接再评论区中分享哦。感谢关注。
