分享 14 个 Spring MVC *技巧！
作者：nam ha minh
https://dzone.com/articles/14-tips-for-writing-spring-mvc-controller
译文：blog.csdn.net/summer_lyf/article/details/102911215
通常，在spring mvc中，我们编写一个控制器类来处理来自客户端的请求。然后，控制器调用业务类来处理与业务相关的任务，然后将客户端重定向到逻辑视图名称，该名称由spring的调度程序servlet解析，以呈现结果或输出。
这样就完成了典型的请求-响应周期的往返。
今天整理了一下编写spring mvc控制器的14个技巧，你今天get到了吗？ \(≧▽≦)/
1.使用@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) {
}
}
正如你可以在上面的控制器类看，有处理三种不同的请求3种处理方法 /listusers，/saveuser_，_和/deleteuser分别。
2.实现控制器接口
在spring mvc中创建控制器的另一种（也许是经典的）方法是让类实现 controller 接口。例如：
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>
此配置指示post 此控制器的hander 方法仅支持该方法。
spring mvc还提供了几种针对特定目的而设计的控制器类，包括：
abstracturlviewcontroller
multiactioncontroller
parameterizableviewcontroller
servletforwardingcontroller
servletwrappingcontroller
urlfilenameviewcontroller
4.为处理程序方法指定url映射
这是编码控制器类时必须执行的强制性任务，该控制器类旨在处理一个或多个特定请求。spring mvc提供了@requestmapping 注释，该注解用于指定url映射。例如：
@requestmapping("/login")
这映射了/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"})
此外，此注解还具有在某些情况下可能有用的其他属性，例如method。
5.为处理程序方法指定http请求方法
可以使用 注解的method 属性 指定处理程序方法支持哪种http方法（get，post，put等） @requestmapping。这是一个例子：
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模式的方法/login，但前者用于 get 方法，而后者用于 post 方法。有关使用@requestmapping 注解的更多信息，请参见 @requestmapping注解。
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
类型转换也是自动完成的。例如，如果您声明integer 如下类型的参数 ：
@requestparam int securitynumber
然后，spring将在处理程序方法中自动将请求参数（字符串）的值转换为指定的类型（整数）。
如果参数名称与变量名称不同，则可以如下指定参数的实际名称：
@requestparam("ssn") int securitynumber
该@requestparam 注解也有两个额外的属性，这可能是在某些情况下是有用的。该属性指定参数是否为必需。例如：required
@requestparam(required = false) string country
这意味着该参数 country 是可选的；因此，它可能会从请求中丢失。在上面的示例中，country 如果请求中不存在此类参数，则变量 将为null。
另一个属性是 defaultvalue，可以在请求参数为空时用作后备值。例如：
@requestparam(defaultvalue = "18") int age
map 如果方法参数是type，spring还允许我们将所有参数作为对象 访问 map<string, string>。例如：
dologin(@requestparam map<string, string> params)
然后，映射参数包含键-值对形式的所有请求参数。有关使用@requestparam 注释的更多信息，请参见 @requestparam注解。关注微信公众号：java技术栈，在后台回复：spring，可以获取我整理的 n 篇最新 spring 教程，都是干货。
7.返回模型和视图
处理完业务逻辑后，处理程序方法应返回一个视图，然后由spring的调度程序servlet对其进行解析。spring允许我们modelandview 从handler 方法中返回string或 对象 。
在以下示例中，该 handler 方法返回一个string并表示一个名为的视图 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 的user 对象和一个可在视图中使用的对象集合 。spring 面试 7 大问题，推荐看下。
spring也非常灵活，因为您可以将modelandview 对象声明 为处理程序方法的参数，而不用创建一个新的对象。因此，以上示例可以重写如下：
@requestmapping("/listusers")
public modelandview listusers(modelandview modelview) {
list<user> listuser = new arraylist<>();
//从dao获取用户列表…
modelview.setviewname("userlist");
modelview.addobject("listuser", listuser);
return modelview;
}
了解有关该类的更多信息，请参见：modelandview class。
8.将对象放入模型
在遵循mvc架构的应用程序中，控制器（c）应该将数据传递到模型（m）中，然后在视图（v）中使用该模型。正如我们在前面的示例中看到的那样， 该类的addobject() 方法 modelandview是以名称-值对的形式将对象放入模型中：
modelview.addobject("listuser", listuser);
modelview.addobject("sitename", new string("codejava.net"));
modelview.addobject("users", 1200000);
同样，spring非常灵活。你可以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 对象。在这里要感谢spring的灵活性。
9.处理程序方法中的重定向
如果你希望在满足条件的情况下将用户重定向到另一个url，请redirect:/ 在url之前追加。以下代码段给出了一个示例：
// 检查登录状态....
if (!islogin) {
return new modelandview("redirect:/login");
}
// 返回用户列表
在上面的代码中，/login 如果未登录，用户将被重定向到该 url。
10.处理表格提交和表格验证
通过提供@modelattribute 用于将表单字段绑定到表单支持对象的注解以及bindingresult 用于验证表单字段的界面，spring使处理表单提交变得容易。下面的代码片段显示了一种典型的处理程序方法，该方法负责处理和验证表单数据：
@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";
}
}
从spring的官方文档中了解有关@modelattribute 注释和bindingresult接口的更多信息：
在方法参数上使用@modelattribute
在方法上使用@modelattribute
接口绑定结果
11.处理文件上传
通过自动将上传数据绑定到commonsmultipartfile 对象数组，spring还使在处理程序方法中处理文件上传变得容易。spring使用apache commons fileupload作为基础的多部分解析器。
以下代码段显示了从客户端上传文件有多么容易
@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自动将业务类的实际实现注入控制器。关注微信公众号：java技术栈，在后台回复：spring，可以获取我整理的 n 篇最新spring boot 教程，都是干货。
考虑以下控制器类的代码段：
@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 注解的更多信息，请参见 注释类型自动装配。
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控制器时，有两个很好的实践是你应该遵循的:
1）控制器类不应执行业务逻辑。相反，它应该将业务处理委托给相关的业务类别。这使控制器始终专注于其设计职责是控制应用程序的工作流程。例如：
@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);
}
}
2）为每个业务域创建每个单独的控制器。例如， usercontroller 用于控制用户管理的ordercontroller 工作流程， 用于控制订单处理的工作流程等。例如：
@controller
public class usercontroller {
}
@controller
public class productcontroller {
}
@controller
public class ordercontroller {
}
@controller
public class paymentcontroller {
}
这14个小技巧，可以帮助你正确有效地在spring mvc中编写控制器类。如果你有其他提示或建议，请随时在评论中分享您的想法。
推荐去我的博客阅读更多：
2.spring mvc、spring boot、spring cloud 系列教程
3.maven、git、eclipse、intellij idea 系列工具教程
生活很美好，明天见～