Spring的模型-视图-控制器(MVC)框架是围绕一个DispatcherServlet来设计的,这个Servlet会把请求分发给各个处理器,并支持可配置的处理器映射、视图渲染、本地化、时区与主题渲染等,甚至还能支持文件上传。处理器是应用中注解了@Controller和@RequestMapping的类和方法,Spring为处理器方法提供了极其多样灵活的配置。Spring 3.0以后提供了@Controller注解机制、@PathVariable注解以及一些其他的特性,可以使用它们来进行RESTful web站点和应用的开发。
用户向服务器发送请求,请求会到DispatcherServlet,DispatcherServlet 对请求URL进行解析,得到请求资源标识符(URI),然后根据该URI,调用HandlerMapping获得该Handler配置的所有相关的对象(包括一个Handler处理器对象、多个HandlerInterceptor拦截器对象),最后以HandlerExecutionChain对象的形式返回。
DispatcherServlet 根据获得的Handler,选择一个合适的HandlerAdapter。提取Request中的模型数据,填充Handler入参,开始执行Handler(Controller)。 在填充Handler的入参过程中,根据你的配置,Spring将帮你做一些额外的工作
1.向服务器发送Http request请求,请求被**前端控制器(DispatcherServlet)**捕获。
2.前端控制器根据xml文件中的配置(或者注解)对请求的URL进行解析,得到请求资源标识符(URI)。然后根据该URI,调用**处理器映射器(HandlerMapping)**获得处理该请求的Handler以及Handler对应的拦截器,最后以 HandlerExecutionChain 对象的形式返回。
3.前端控制器根据获得的Handler,选择一个合适的**处理器适配器(HandlerAdapter)**去执行该Handler。
4.处理器适配器提取request中的模型数据,填充Handler入参,执行处理器(Handler)(也称之为Controller).
5.Handler(Controller)执行完成后,向处理器适配器返回一个ModelAndView对象,处理器适配器再向前端控制器返回该ModelAndView对象(ModelAndView只是一个逻辑视图)。
6.根据返回的ModelAndView,前端控制器请求一个适合的视图解析器(ViewResolver)(必须是已经注册到Spring容器中的ViewResolver)去进行视图解析,然后视图解析器向前端控制器返回一个真正的视图View(jsp)。
7.前端控制器通过Model解析出ModelAndView中的参数进行解析,最终展现出完整的View并通过Http response返回给客户端。
使用@Controller注解定义一个控制器
@Controller
注解表明了一个类是作为控制器的角色而存在的。Spring不要求你去继承任何控制器基类,也不要求你去实现Servlet的那套API。当然,如果你需要的话也可以去使用任何与Servlet相关的特性和设施
使用@RequestMapping注解映射请求路径
使用@RequestMapping
注解来将请求URL,如/appointments
等,映射到整个类上或某个特定的处理器方法上。一般来说,类级别的注解负责将一个特定(或符合某种模式)的请求路径映射到一个控制器上,同时通过方法级别的注解来细化映射,即根据特定的HTTP请求方法(“GET”“POST”方法等)、HTTP请求中是否携带特定参数等条件,将请求映射到匹配的方法上。
下面这段代码示例来自Petcare,它展示了在Spring MVC中如何在控制器上使用@RequestMapping
注解:
@Controller
@RequestMapping("/appointments")
public class AppointmentsController {
private final AppointmentBook appointmentBook;
@Autowired
public AppointmentsController(AppointmentBook appointmentBook) {
this.appointmentBook = appointmentBook;
}
@RequestMapping(method = RequestMethod.GET)
public Map<String, Appointment> get() {
return appointmentBook.getAppointmentsForToday();
}
@RequestMapping(path = "/{day}", method = RequestMethod.GET)
public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {
return appointmentBook.getAppointmentsForDay(day);
}
@RequestMapping(path = "/new", method = RequestMethod.GET)
public AppointmentForm getNewForm() {
return new AppointmentForm();
}
@RequestMapping(method = RequestMethod.POST)
public String add(@Valid AppointmentForm appointment, BindingResult result) {
if (result.hasErrors()) {
return "appointments/new";
}
appointmentBook.addAppointment(appointment);
return "redirect:/appointments";
}
}
在上面的示例中,许多地方都使用到了@RequestMapping
注解。第一次使用点是作用于类级别的,它指示了所有/appointments
开头的路径都会被映射到控制器下。get()
方法上的@RequestMapping
注解对请求路径进行了进一步细化:它仅接受GET方法的请求。这样,一个请求路径为/appointments
、HTTP方法为GET的请求,将会最终进入到这个方法被处理。add()
方法也做了类似的细化,而getNewForm()
方法则同时注解了能够接受的请求的HTTP方法和路径。这种情况下,一个路径为appointments/new
、HTTP方法为GET的请求将会被这个方法所处理。
getForDay()
方法则展示了使用@RequestMapping
注解的另一个技巧:URI模板。(关于URI模板,请见下小节)
类级别的@RequestMapping
注解并不是必须的。不配置的话则所有的路径都是绝对路径,而非相对路径。以下的代码示例来自PetClinic,它展示了一个具有多个处理器方法的控制器:
@Controller
public class ClinicController {
private final Clinic clinic;
@Autowired
public ClinicController(Clinic clinic) {
this.clinic = clinic;
}
@RequestMapping("/")
public void welcomeHandler() {
}
@RequestMapping("/vets")
public ModelMap vetsHandler() {
return new ModelMap(this.clinic.getVets());
}
}
使用@RequestParam将请求参数绑定至方法参数
可以使用@RequestParam
注解将请求参数绑定到你控制器的方法参数上
下面这段代码展示了它的用法:
@Controller
@RequestMapping("/pets")
@SessionAttributes("pet")
public class EditPetForm {
// ...
@RequestMapping(method = RequestMapping.GET)
public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
Pet pet = this.clinic.loadPet(petId);
model.addAttribute("pet", pet);
return "petForm";
}
// ,..
}
若参数使用了该注解,则该参数默认是必须提供的,但你也可以把该参数标注为非必须的:只需要将@RequestParam
注解的required
属性设置为false
即可(比如,@RequestParam(path="id", required=false)
)。
若所注解的方法参数类型不是String
,则类型转换会自动地发生。详见"方法参数与类型转换"一节
若@RequestParam
注解的参数类型是Map<String, String>
或者MultiValueMap<String, String>
,则该Map中会自动填充所有的请求参数。