Java SpringMVC
通常,在Spring MVC中,编写一个控制器类来处理来自客户端的请求。然后,控制器调用业务类来处理与业务相关的任务,然后将客户端重定向到逻辑视图名称,该名称由Spring的调度程序Servlet解析,以呈现结果或输出。这样就完成了典型的请求-响应周期的往返。

1、使用@Controller构造型

这是创建可以处理一个或多个请求的控制器类的最简单方法。仅通过用构造型注释一个类@Controller ,例如:

  1. import org.springframework.stereotype.Controller;
  2. import org.springframework.web.bind.annotation.RequestMapping;
  3. @Controller
  4. public class HomeController {
  5. @RequestMapping("/")
  6. public String visitHome() {
  7. return "home";
  8. }
  9. }

visitHome()方法通过重定向到名为home的视图来处理来自应用程序上下文路径(/)的请求。
注意:@Controller原型只能在Spring的配置文件中启用注解驱动时使用:

  1. <annotation-driven />

启用注释驱动时,Spring容器自动在以下语句指定的包下扫描类:

  1. <context:component-scan base-package="net.codejava.spring" />

@Controller 注释注释的类被配置为控制器。这是最可取的,因为它很简单:无需在配置文件中为控制器声明bean。
注意:通过使用@Controller 注解,可以拥有一个多动作控制器类,该类能够处理多个不同的请求。例如:

  1. @Controller
  2. public class MultiActionController {
  3. @RequestMapping("/listUsers")
  4. public ModelAndView listUsers() {
  5. }
  6. @RequestMapping("/saveUser")
  7. public ModelAndView saveUser(User user) {
  8. }
  9. @RequestMapping("/deleteUser")
  10. public ModelAndView deleteUser(User user) {
  11. }
  12. }

正如可以在上面的控制器类看,有处理三种不同的请求3种处理方法 /listUsers/saveUser,和/deleteUser分别。

2、实现控制器接口

在Spring MVC中创建控制器的另一种(也许是经典的)方法是让类实现 Controller 接口。例如:

  1. import javax.servlet.http.HttpServletRequest;
  2. import javax.servlet.http.HttpServletResponse;
  3. import org.springframework.web.servlet.ModelAndView;
  4. import org.springframework.web.servlet.mvc.Controller;
  5. public class MainController implements Controller {
  6. @Override
  7. public ModelAndView handleRequest(HttpServletRequest request,
  8. HttpServletResponse response) throws Exception {
  9. System.out.println("Welcome main");
  10. return new ModelAndView("main");
  11. }
  12. }

实现类必须重写该 handleRequest() 方法,当匹配请求进入时,该方法将由Spring调度程序Servlet调用。此控制器处理的请求URL模式在Spring的上下文配置文件中定义如下:

  1. <bean name="/main" class="net.codejava.spring.MainController" />

但是,此方法的缺点是控制器类无法处理多个请求URL。

3、扩展AbstractController

如果要轻松控制受支持的HTTP方法,会话和内容缓存。扩展控制器 AbstractController 类是理想的选择。请考虑以下示例:

  1. import javax.servlet.http.HttpServletRequest;
  2. import javax.servlet.http.HttpServletResponse;
  3. import org.springframework.web.servlet.ModelAndView;
  4. import org.springframework.web.servlet.mvc.AbstractController;
  5. public class BigController extends AbstractController {
  6. @Override
  7. protected ModelAndView handleRequestInternal(HttpServletRequest request,
  8. HttpServletResponse response) throws Exception {
  9. System.out.println("You're big!");
  10. return new ModelAndView("big");
  11. }
  12. }

这将创建具有有关受支持的方法,会话和缓存的配置的单动作控制器,然后可以在控制器的bean声明中指定这些配置。例如:

  1. <bean name="/big" class="net.codejava.spring.BigController">
  2. <property name="supportedMethods" value="POST"/>
  3. </bean>

此配置指示POST 此控制器的hander 方法仅支持该方法。
Spring MVC还提供了几种针对特定目的而设计的控制器类,包括:

  • AbstractUrlViewController
  • MultiActionController
  • ParameterizableViewController
  • ServletForwardingController
  • ServletWrappingController
  • UrlFilenameViewController

    4、为处理程序方法指定URL映射

    这是编码控制器类时必须执行的强制性任务,该控制器类旨在处理一个或多个特定请求。Spring MVC提供了@RequestMapping 注释,该注解用于指定URL映射。例如:

    1. @RequestMapping("/login")

    这映射了/login 要由带注解的方法或类处理的URL模式。当在类级别使用此注解时,该类将成为单动作控制器。例如:

    1. import org.springframework.stereotype.Controller;
    2. import org.springframework.web.bind.annotation.RequestMapping;
    3. import org.springframework.web.bind.annotation.RequestMethod;
    4. @Controller
    5. @RequestMapping("/hello")
    6. public class SingleActionController {
    7. @RequestMapping(method = RequestMethod.GET)
    8. public String sayHello() {
    9. return "hello";
    10. }
    11. }

    @RequestMapping 注解在方法级别使用的,可以有一个多动作控制器。例如:

    1. import org.springframework.stereotype.Controller;
    2. import org.springframework.web.bind.annotation.RequestMapping;
    3. @Controller
    4. public class UserController {
    5. @RequestMapping("/listUsers")
    6. public String listUsers() {
    7. return "ListUsers";
    8. }
    9. @RequestMapping("/saveUser")
    10. public String saveUser() {
    11. return "EditUser";
    12. }
    13. @RequestMapping("/deleteUser")
    14. public String deleteUser() {
    15. return "DeleteUser";
    16. }
    17. }

    @RequestMapping注释还可以用于指定一个方法要处理的多个URL模式。例如:

    1. @RequestMapping({"/hello", "/hi", "/greetings"})

    此外,此注解还具有在某些情况下可能有用的其他属性,例如method。

    5、为处理程序方法指定HTTP请求方法

    可以使用 注解的method 属性 指定处理程序方法支持哪种HTTP方法(GET,POST,PUT等) @RequestMapping。这是一个例子:

    1. import org.springframework.stereotype.Controller;
    2. import org.springframework.web.bind.annotation.RequestMapping;
    3. import org.springframework.web.bind.annotation.RequestMethod;
    4. @Controller
    5. public class LoginController {
    6. @RequestMapping(value = "/login", method = RequestMethod.GET)
    7. public String viewLogin() {
    8. return "LoginForm";
    9. }
    10. @RequestMapping(value = "/login", method = RequestMethod.POST)
    11. public String doLogin() {
    12. return "Home";
    13. }
    14. }

    此控制器有两个处理相同URL模式的方法/login,但前者用于 GET 方法,而后者用于 POST 方法。
    有关使用@RequestMapping 注解的更多信息,请参见 @RequestMapping注解。

    6、将请求参数映射到处理程序方法

    Spring MVC的很酷的功能之一是,可以使用@RequestParam 注解将请求参数作为处理程序方法的常规参数进行检索。这是将控制器HttpServletRequest与Servlet API 的接口分离的好方法。

    1. @RequestMapping(value = "/login", method = RequestMethod.POST)
    2. public String doLogin(@RequestParam String username,
    3. @RequestParam String password) {
    4. }

    Spring将方法参数用户名和密码绑定到具有相同名称的HTTP请求参数。这意味着可以按以下方式调用URL(如果请求方法是GET):

    1. http://localhost8080/spring/loginusername=Fcant&password=tiger

    类型转换也是自动完成的。例如,如果声明integer 如下类型的参数 :

    1. @RequestParam int securityNumber

    然后,Spring将在处理程序方法中自动将请求参数(字符串)的值转换为指定的类型(整数)。
    如果参数名称与变量名称不同,则可以如下指定参数的实际名称:

    1. @RequestParam("SSN") int securityNumber

    @RequestParam 注解也有两个额外的属性,这可能是在某些情况下是有用的。该属性指定参数是否为必需。例如: required

    1. @RequestParam(required = false) String country

    这意味着该参数 country 是可选的;因此,它可能会从请求中丢失。在上面的示例中,country 如果请求中不存在此类参数,则变量 将为null。
    另一个属性是 defaultValue,可以在请求参数为空时用作后备值。例如:

    1. @RequestParam(defaultValue = "18") int age

    Map 如果方法参数是type,Spring还允许将所有参数作为对象 访问 Map<String, String>。例如:

    1. doLogin(@RequestParam Map<String, String> params)

    然后,映射参数包含键-值对形式的所有请求参数。有关使用@RequestParam 注释的更多信息,请参见 @RequestParam注解。

    7、返回模型和视图

    处理完业务逻辑后,处理程序方法应返回一个视图,然后由Spring的调度程序servlet对其进行解析。Spring允许ModelAndView 从handler 方法中返回String或 对象 。在以下示例中,该 handler 方法返回一个String并表示一个名为的视图 LoginForm:

    1. @RequestMapping(value = "/login", method = RequestMethod.GET)
    2. public String viewLogin() {
    3. return "LoginForm";
    4. }

    这是返回视图名称的最简单方法。但是,如果要将其他数据发送到视图,则必须返回一个 ModelAndView 对象。考虑以下处理程序方法:

    1. @RequestMapping("/listUsers")
    2. public ModelAndView listUsers() {
    3. List<User> listUser = new ArrayList<>();
    4. // 从DAO获取用户列表…
    5. ModelAndView modelView = new ModelAndView("UserList");
    6. modelView.addObject("listUser", listUser);
    7. return modelView;
    8. }

    此处理程序方法返回一个 ModelAndView 保存视图名称 UserList 的User 对象和一个可在视图中使用的对象集合 。
    Spring也非常灵活,可以将ModelAndView 对象声明 为处理程序方法的参数,而不用创建一个新的对象。因此,以上示例可以重写如下:

    1. @RequestMapping("/listUsers")
    2. public ModelAndView listUsers(ModelAndView modelView) {
    3. List<User> listUser = new ArrayList<>();
    4. //从DAO获取用户列表…
    5. modelView.setViewName("UserList");
    6. modelView.addObject("listUser", listUser);
    7. return modelView;
    8. }

    了解有关该类的更多信息,请参见 :ModelAndView class。

    8、将对象放入模型

    在遵循MVC架构的应用程序中,控制器(C)应该将数据传递到模型(M)中,然后在视图(V)中使用该模型。正如在前面的示例中看到的那样, 该类的addObject() 方法 ModelAndView是以名称-值对的形式将对象放入模型中:

    1. modelView.addObject("listUser", listUser);
    2. modelView.addObject("siteName", new String("CodeJava.net"));
    3. modelView.addObject("users", 1200000);

    同样,Spring非常灵活。可以Map 在处理程序方法中声明类型的参数 。Spring使用此映射存储模型的对象。看另一个例子:

    1. @RequestMapping(method = RequestMethod.GET)
    2. public String viewStats(Map<String, Object> model) {
    3. model.put("siteName", "CodeJava.net");
    4. model.put("pageviews", 320000);
    5. return "Stats";
    6. }

    这比使用ModelAndView 对象还要简单 。根据喜好,可以使用Map 或 使用 ModelAndView 对象。在这里要感谢Spring的灵活性。

    9、处理程序方法中的重定向

    如果希望在满足条件的情况下将用户重定向到另一个URL,请redirect:/ 在URL之前追加。以下代码段给出了一个示例:

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

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

    10、处理表格提交和表格验证

    通过提供@ModelAttribute 用于将表单字段绑定到表单支持对象的注解以及BindingResult 用于验证表单字段的界面,Spring使处理表单提交变得容易。下面的代码片段显示了一种典型的处理程序方法,该方法负责处理和验证表单数据:

    1. @Controller
    2. public class RegistrationController {
    3. @RequestMapping(value = "/doRegister", method = RequestMethod.POST)
    4. public String doRegister(
    5. @ModelAttribute("userForm") User user, BindingResult bindingResult) {
    6. if (bindingResult.hasErrors()) {
    7. // 表单验证错误
    8. } else {
    9. // 表单输入没问题
    10. }
    11. // 注册过程……
    12. return "Success";
    13. }
    14. }

    从Spring的官方文档中了解有关@ModelAttribute 注释和BindingResult 接口的更多信息 :

  • 在方法参数上使用@ModelAttribute

  • 在方法上使用@ModelAttribute
  • 接口绑定结果

    11、处理文件上传

    通过自动将上传数据绑定到CommonsMultipartFile 对象数组,Spring还使在处理程序方法中处理文件上传变得容易。Spring使用Apache Commons FileUpload作为基础的多部分解析器。
    以下代码段显示了从客户端上传文件有多么容易

    1. @RequestMapping(value = "/uploadFiles", method = RequestMethod.POST)
    2. public String handleFileUpload(
    3. @RequestParam CommonsMultipartFile[] fileUpload) throws Exception {
    4. for (CommonsMultipartFile aFile : fileUpload){
    5. // 存储上传的文件
    6. aFile.transferTo(new File(aFile.getOriginalFilename()));
    7. }
    8. return "Success";
    9. }

    12、在控制器中自动装配业务类

    控制器应将业务逻辑的处理委托给相关的业务类。为此,可以使用@Autowired 注解让Spring自动将业务类的实际实现注入控制器。考虑以下控制器类的代码段:

    1. @Controller
    2. public class UserController {
    3. @Autowired
    4. private UserDAO userDAO;
    5. public String listUser() {
    6. // 列出所有用户的处理方法
    7. userDAO.list();
    8. }
    9. public String saveUser(User user) {
    10. // 保存/更新用户的处理方法
    11. userDAO.save(user);
    12. }
    13. public String deleteUser(User user) {
    14. // 删除用户的处理方法
    15. userDAO.delete(user);
    16. }
    17. public String getUser(int userId) {
    18. // 获取用户的处理方法
    19. userDAO.get(userId);
    20. }
    21. }

    在此,与用户管理有关的所有业务逻辑都由该UserDAO 接口的实现提供 。例如:

    1. interface UserDAO {
    2. List<User> list();
    3. void save(User user);
    4. void checkLogin(User user);
    5. }

    有关@Autowired注解的更多信息,请参见 注释类型自动装配。

    13、访问HttpServletRequestHttpServletResponse

    在某些情况下,需要直接 在处理程序方法中访问 HttpServletRequestHttpServletResponse对象。通过Spring的灵活性,只需在处理方法中添加相关参数即可。例如:

    1. @RequestMapping("/download")
    2. public String doDownloadFile(
    3. HttpServletRequest request, HttpServletResponse response) {
    4. // 访问请求
    5. // 访问响应
    6. return "DownloadPage";
    7. }

    Spring检测并自动将HttpServletRequestHttpServletResponse 对象注入方法中。然后,可以访问请求和响应如获取InputStreamOutputStream或返回一个特定的HTTP代码。

    14、遵循单一责任原则

    最后,在设计和编写Spring MVC控制器时,有两个很好的实践是应该遵循的:

  • 控制器类不应执行业务逻辑。相反,它应该将业务处理委托给相关的业务类别。这使控制器始终专注于其设计职责是控制应用程序的工作流程。例如:

    1. @Controller
    2. public class UserController {
    3. @Autowired
    4. private UserDAO userDAO;
    5. public String listUser() {
    6. userDAO.list();
    7. }
    8. public String saveUser(User user) {
    9. userDAO.save(user);
    10. }
    11. public String deleteUser(User user) {
    12. userDAO.delete(user);
    13. }
    14. public String getUser(int userId) {
    15. userDAO.get(userId);
    16. }
    17. }
  • 为每个业务域创建每个单独的控制器。例如,UserController 用于控制用户管理的OrderController工作流程, 用于控制订单处理的工作流程等。例如:

    1. @Controller
    2. public class UserController {
    3. }
    4. @Controller
    5. public class ProductController {
    6. }
    7. @Controller
    8. public class OrderController {
    9. }
    10. @Controller
    11. public class PaymentController {
    12. }