SpringMVC学习笔记

强烈推荐使用Spring Boot，搭建Spring Web项目，进入网址，把WEB依赖打钩，点击生成项目，会下载一个压缩包，将压缩包解压导入Eclipse, Intellij IDEA均可.或者使用Intellij IDEA自带的Spring boot生成插件.

QQ20170930-140228.png

一、SpringMVC基础入门，创建一个HelloWorld程序

1.首先，导入SpringMVC需要的jar包。

 
       org.springframework
       spring-webmvc

2.添加Web.xml配置文件中关于SpringMVC的配置

  
  
      springmvc
      org.springframework.web.servlet.DispatcherServlet
      
            contextConfigLocation
            classpath:springmvc-servlet.xml
        
        
  

  
      springmvc
      /

3.在src下添加springmvc-servlet.xml配置文件

4.在WEB-INF文件夹下创建名为jsp的文件夹，用来存放jsp视图。创建一个hello.jsp，在body中添加“Hello World”。

5.建立包及Controller，如下所示

6.编写Controller代码

类级别的@RequestMapping,注解并不是必须的。不配置的话则所有的路径都是绝对路径，而非相对路径

@Controller
@RequestMapping("/mvc")
public class mvcController {

    @RequestMapping("/hello")
    public String hello(){        
        return "hello";
    }
}

7.启动服务器，键入 http://localhost:8080/项目名/mvc/hello

二、配置解析

1.Dispatcherservlet

DispatcherServlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据相应的规则分发到目标Controller来处理，是配置spring MVC的第一步。

2.InternalResourceViewResolver

视图名称解析器

3.以上出现的注解

@Controller 负责注册一个bean 到spring 上下文中

@RequestMapping 注解为控制器指定可以处理哪些 URL 请求

三、SpringMVC常用注解

@Controller

负责注册一个bean 到spring 上下文中

@RequestMapping

注解为控制器指定可以处理哪些 URL 请求,
该注解支持URI模板变量中使用正则表达式。语法是{varName:regex}，其中第一部分定义了变量名，第二部分就是你所要应用的正则表达式。比如下面的代码样例

@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{extension:\\.[a-z]+}") 
public void handle(@PathVariable String version, @PathVariable String extension) { 
// 代码部分省略... 
}

当一个URL同时匹配多个模板（pattern）时

URI模板变量的数目和通配符数量的总和最少的那个路径模板更准确.
如果两个模板的URI模板数量和通配符数量总和一致，则路径更长的那个模板更准确。
如果两个模板的数量和长度均一致，则那个具有更少通配符的模板是更加准确的
@RequestBody

该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上 ,再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上.

@ResponseBody

该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区, 会根据HTTP请求头的contentType或者appect的内容自动转换返回类型,例如xml或者json.
用此注解或者ResponseEntity等类似类, 会导致response header含有accept-charset这个字段,而这个字段对于响应头是没有用的,以下方法可以关掉

@ModelAttribute

在方法定义上使用 @ModelAttribute 注解：Spring MVC 在调用目标处理方法前，会先逐个调用在方法级上标注了@ModelAttribute 的方法

在方法的入参前使用 @ModelAttribute 注解：可以从隐含对象中获取隐含的模型数据中获取对象，再将请求参数 –绑定到对象中，再传入入参将方法入参对象添加到模型中

@RequestParam

在处理方法入参处使用 @RequestParam 可以把请求参数传递给请求方法

@CookieValue
关于Coookie的注解, 类似,肯定还有关于session的注解.
@PathVariable

绑定 URL 占位符到入参, 例如

@RequestMapping(value = "/person/profile/{id}")  
public String porfile(@PathVariable("id") int uid) { ... }

@ExceptionHandler

注解到方法上，出现异常时会执行该方法

@ControllerAdvice

使一个Contoller成为全局的异常处理类，类中用@ExceptionHandler方法注解的方法可以处理所有Controller发生的异常

四、自动匹配参数

    //match automatically
    @RequestMapping("/person")
    public String toPerson(String name,double age){
        System.out.println(name+" "+age);
        return "hello";
    }

五、自动装箱

1.编写一个Person实体类

package test.SpringMVC.model;

public class Person {
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    private String name;
    private int age;
    
}

2.在Controller里编写方法

    //boxing automatically
    @RequestMapping("/person1")
    public String toPerson(Person p){
        System.out.println(p.getName()+" "+p.getAge());
        return "hello";
    }

六、使用InitBinder来处理Date类型的参数

    //the parameter was converted in initBinder
    @RequestMapping("/date")
    public String date(Date date){
        System.out.println(date);
        return "hello";
    }
    
    //At the time of initialization,convert the type "String" to type "date"
    @InitBinder
    public void initBinder(ServletRequestDataBinder binder){
        binder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"),
                true));
    }

七、向前台传递参数

使用普通mp

//pass the parameters to front-end
    @RequestMapping("/show")
    public String showPerson(Map map){
        Person p =new Person();
        map.put("p", p);
        p.setAge(20);
        p.setName("jayjay");
        return "show";
    }

前台可在Request域中取到"p"

使用ModelAndView
ModelAndView类其实就是一个豪华版的 Map，它使得你为视图展示需要所添加的对象都遵循一个显而易见的约定被命名。请看下面这个 Controller实现，并请注意，添加到ModelAndView中去的对象都没有显式地指定键名。

public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)
 {
        List cartItems = // 拿到一个CartItem对象的列表
        User user = // 拿到当前购物的用户User 
        ModelAndView mav = new ModelAndView("displayShoppingCart"); <-- 逻辑视图名
        mav.addObject(cartItems); <-- 啊哈，直接添加的对象，没有指定名称
        mav.addObject(user); <-- 啊哈再来一次 return mav; 
}

ModelAndView实例中的纯Java对象所生成的名称规则:

添加一个x.y.User实例，为其生成的名称为user
添加一个java.util.HashMap实例，为其生成的名称为hashMap。这种情况下，显式地声明一个键名可能更好，因为hashMap的约定并非那么符合直觉
添加一个null值将导致程序抛出一个IllegalArgumentException参数非法异常。若你所添加的（多个）对象有可能为null值，那你也需要显式地指定它（们）的名字
添加一个带零个或多个x.y.User元素类型的数组x.y.User[]，为其生成的键名是userList
添加一个带零个或多个x.y.User元素类型的数组java.util.ArrayList，为其生成的键名是userList
添加一个带零个或多个x.y.Foo元素类型的数组java.util.HashSet，为其生成的键名是fooList
一个空的 java.util.ArrayList则根本不会被添加

八、使用Ajax调用

    //pass the parameters to front-end using ajax
    @RequestMapping("/getPerson")
    public void getPerson(String name,PrintWriter pw){
        pw.write("hello,"+name);        
    }
    @RequestMapping("/name")
    public String sayHello(){
        return "name";
    }

前台用下面的Jquery代码调用

          $(function(){
              $("#btn").click(function(){
                  $.post("mvc/getPerson",{name:$("#name").val()},function(data){
                      alert(data);
                  });
              });
          });

九、在Controller中使用redirect方式处理请求

//redirect 
@RequestMapping("/redirect")
public String redirect(){
    return "redirect:hello";
}

十、文件上传

1.需要导入两个jar包


 
  commons-fileupload
  commons-fileupload
  1.3.1


  commons-io
  commons-io
  2.4

2.在SpringMVC配置文件中加入

3.方法代码

    @RequestMapping(value="/upload",method=RequestMethod.POST)
    public String upload(HttpServletRequest req) throws Exception{
        MultipartHttpServletRequest mreq = (MultipartHttpServletRequest)req;
        MultipartFile file = mreq.getFile("file");
        String fileName = file.getOriginalFilename();
        SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");        
        FileOutputStream fos = new FileOutputStream(req.getSession().getServletContext().getRealPath("/")+
                "upload/"+sdf.format(new Date())+fileName.substring(fileName.lastIndexOf('.')));
        fos.write(file.getBytes());
        fos.flush();
        fos.close();
        
        return "hello";
    }

或者

@RequestMapping(value = "/doUpload", method = RequestMethod.POST)
public String doUpload(@RequestParam("file") MultipartFile file) {
    if (!file.isEmpty()) {
        log.debug("Process File: {}, filename is {}", file.getOriginalFilename(), file.getName());
        try {
            FileUtils.copyInputStreamToFile(file.getInputStream(), 
                    new File("/home/username/", System.currentTimeMillis() + file.getOriginalFilename()));
        } catch (Exception e) {
            //e.printStackTrace();        
        }
   }
    return "success";
}

4.前台form表单

十一、使用@RequestParam注解指定参数的name

@Controller
@RequestMapping("/test")
public class mvcController1 {
    @RequestMapping(value="/param")
    public String testRequestParam(@RequestParam(value="id") Integer id,
            @RequestParam(value="name")String name){
        System.out.println(id+" "+name);
        return "/hello";
    }    
}

十二、RESTFul风格的SringMVC

1.RestController

@Controller
@RequestMapping("/rest")
public class RestController {
    @RequestMapping(value="/user/{id}",method=RequestMethod.GET)
    public String get(@PathVariable("id") Integer id){
        System.out.println("get"+id);
        return "/hello";
    }
    
    @RequestMapping(value="/user/{id}",method=RequestMethod.POST)
    public String post(@PathVariable("id") Integer id){
        System.out.println("post"+id);
        return "/hello";
    }
    
    @RequestMapping(value="/user/{id}",method=RequestMethod.PUT)
    public String put(@PathVariable("id") Integer id){
        System.out.println("put"+id);
        return "/hello";
    }
    
    @RequestMapping(value="/user/{id}",method=RequestMethod.DELETE)
    public String delete(@PathVariable("id") Integer id){
        System.out.println("delete"+id);
        return "/hello";
    }
    
}

2.form表单发送put和delete请求

在web.xml中配置

  
  
      HiddenHttpMethodFilter
      org.springframework.web.filter.HiddenHttpMethodFilter
  
  
      HiddenHttpMethodFilter
      /*

在前台可以用以下代码产生请求

十三、返回json格式的字符串

1.导入以下jar包



    com.fasterxml.jackson.core
    jackson-databind
    2.8.1

2.方法代码

@Controller
@RequestMapping("/json")
public class jsonController {
    
    @ResponseBody
    @RequestMapping("/user")
    public  User get(){
        User u = new User();
        u.setId(1);
        u.setName("jayjay");
        u.setBirth(new Date());
        return u;
    }
}

十四、异常的处理

1.处理局部异常（Controller内）

    @ExceptionHandler
    public ModelAndView exceptionHandler(Exception ex){
        ModelAndView mv = new ModelAndView("error");
        mv.addObject("exception", ex);
        System.out.println("in testExceptionHandler");
        return mv;
    }
    
    @RequestMapping("/error")
    public String error(){
        int i = 5/0;
        return "hello";
    }

2.处理全局异常（所有Controller）

@ControllerAdvice
public class testControllerAdvice {
    @ExceptionHandler
    public ModelAndView exceptionHandler(Exception ex){
        ModelAndView mv = new ModelAndView("error");
        mv.addObject("exception", ex);
        System.out.println("in testControllerAdvice");
        return mv;
    }
}

3.另一种处理全局异常的方法

在SpringMVC配置文件中配置

error是出错页面

十五、设置一个自定义拦截器

1.创建一个MyInterceptor类，并实现HandlerInterceptor接口

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public void afterCompletion(HttpServletRequest arg0,
            HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("afterCompletion");
    }

    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1,
            Object arg2, ModelAndView arg3) throws Exception {
        System.out.println("postHandle");
    }

    @Override
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1,
            Object arg2) throws Exception {
        System.out.println("preHandle");
        return true;
    }

}

2.在SpringMVC的配置文件中配置

此处**是全部拦截。
3.拦截器执行顺序

十六 HTTP缓存支持

对静态资源的HTTP缓存支持

为优化站点性能，静态资源应该带有恰当的Cache-Control值与其他必要的头.
java配置

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resources/**")
                .addResourceLocations("/public-resources/")
                .setCacheControl(CacheControl.maxAge(1, TimeUnit.HOURS).cachePublic());
    }
}

或者xml配置

十七、表单的验证（使用Hibernate-validate）及国际化

1.导入Hibernate-validate需要的jar包

(未选中不用导入)

2.编写实体类User并加上验证注解

public class User {
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Date getBirth() {
        return birth;
    }
    public void setBirth(Date birth) {
        this.birth = birth;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", name=" + name + ", birth=" + birth + "]";
    }    
    private int id;
    @NotEmpty
    private String name;

    @Past
    @DateTimeFormat(pattern="yyyy-MM-dd")
    private Date birth;
}

ps:@Past表示时间必须是一个过去值

3.在jsp中使用SpringMVC的form表单

    
        id:

        name:

        birth:

ps:path对应name

4.Controller中代码

@Controller
@RequestMapping("/form")
public class formController {
    @RequestMapping(value="/add",method=RequestMethod.POST)    
    public String add(@Valid User u,BindingResult br){
        if(br.getErrorCount()>0){            
            return "addUser";
        }
        return "showUser";
    }
    
    @RequestMapping(value="/add",method=RequestMethod.GET)
    public String add(Map map){
        map.put("user",new User());
        return "addUser";
    }
}

ps:
1.因为jsp中使用了modelAttribute属性，所以必须在request域中有一个"user".
2.@Valid 表示按照在实体上标记的注解验证参数
3.返回到原页面错误信息回回显，表单也会回显

5.错误信息自定义

在src目录下添加locale.properties

NotEmpty.user.name=name can't not be empty
Past.user.birth=birth should be a past value
DateTimeFormat.user.birth=the format of input is wrong
typeMismatch.user.birth=the format of input is wrong
typeMismatch.user.id=the format of input is wrong

在SpringMVC配置文件中配置

6.国际化显示

在src(有的是resources)下添加locale_zh_CN.properties

username=账号
password=密码
locale.properties中添加

username=user name
password=password

创建一个locale.jsp

在SpringMVC中配置

让locale.jsp在WEB-INF下也能直接访问

最后，访问locale.jsp，切换浏览器语言，能看到账号和密码的语言也切换了

十八、压轴大戏--整合SpringIOC和SpringMVC

1.创建一个test.SpringMVC.integrate的包用来演示整合，并创建各类

2.User实体类

public class User {
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Date getBirth() {
        return birth;
    }
    public void setBirth(Date birth) {
        this.birth = birth;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", name=" + name + ", birth=" + birth + "]";
    }    
    private int id;
    @NotEmpty
    private String name;

    @Past
    @DateTimeFormat(pattern="yyyy-MM-dd")
    private Date birth;
}

3.UserService类

@Component
public class UserService {
    public UserService(){
        System.out.println("UserService Constructor...\n\n\n\n\n\n");
    }
    
    public void save(){
        System.out.println("save");
    }
}

4.UserController

@Controller
@RequestMapping("/integrate")
public class UserController {
    @Autowired
    private UserService userService;
    
    @RequestMapping("/user")
    public String saveUser(@RequestBody @ModelAttribute User u){
        System.out.println(u);
        userService.save();
        return "hello";
    }
}

5.Spring配置文件

在src目录下创建SpringIOC的配置文件applicationContext.xml

在Web.xml中添加配置

  
  
      org.springframework.web.context.ContextLoaderListener
  
    
    contextConfigLocation  
    classpath:applicationContext.xml

6.在SpringMVC中进行一些配置，防止SpringMVC和SpringIOC对同一个对象的管理重合

十九、SpringMVC详细运行流程图

二十、SpringMVC运行原理

客户端请求提交到DispatcherServlet
由DispatcherServlet控制器查询一个或多个HandlerMapping，找到处理请求的Controller
DispatcherServlet将请求提交到Controller
Controller调用业务逻辑处理后，返回ModelAndView
DispatcherServlet查询一个或多个ViewResoler视图解析器，找到ModelAndView指定的视图
视图负责将结果显示到客户端