乐趣区

关于spring-mvc:编写Spring-MVC控制器的14个技巧

jiezi

通常，在 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) {}}

正如你能够在下面的控制器类看，有解决三种不同的申请 3 种解决办法 /listUsers，/saveUser，和 /deleteUser 别离。

实现控制器接口

在 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。

扩大 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

为处理程序办法指定 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。

为处理程序办法指定 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 注解。

将申请参数映射到处理程序办法

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 注解。

返回模型和视图

解决完业务逻辑后，处理程序办法应返回一个视图，而后由 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 也非常灵活，因为您能够将 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。

将对象放入模型

在遵循 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 的灵活性。

处理程序办法中的重定向

如果你心愿在满足条件的状况下将用户重定向到另一个 URL，请 redirect:/ 在 URL 之前追加。以下代码段给出了一个示例：

// 查看登录状态....
if (!isLogin) {return new ModelAndView("redirect:/login");
}
// 返回用户列表

在下面的代码中，/login 如果未登录，用户将被重定向到该 URL。

解决表格提交和表格验证

通过提供 @ModelAttribute 用于将表单字段绑定到表单反对对象的注解以及 BindingResult 用于验证表单字段的界面，Spring 使解决表单提交变得容易。java 培训上面的代码片段显示了一种典型的处理程序办法，该办法负责解决和验证表单数据：

@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

接口绑定后果

解决文件上传

通过主动将上传数据绑定到 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";
}

在控制器中主动拆卸业务类

控制器应将业务逻辑的解决委托给相干的业务类。为此，您能够应用 @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 注解的更多信息，请参见 正文类型主动拆卸。

拜访 HttpServletRequest 和 HttpServletResponse

在某些状况下，您须要间接 在处理程序办法中拜访 HttpServletRequest 或 HttpServletResponse 对象。通过 Spring 的灵活性，只需在解决办法中增加相干参数即可。例如：

@RequestMapping("/download")
public String doDownloadFile(HttpServletRequest request, HttpServletResponse response) {
    // 拜访申请
    // 拜访响应
    return "DownloadPage";
}

Spring 检测并主动将 HttpServletRequest 和 HttpServletResponse 对象注入办法中。而后，能够拜访申请和响应如获取 InputStream，OutputStream 或返回一个特定的 HTTP 代码。

遵循繁多责任准则

最初，在设计和编写 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 {}
退出移动版