Springmvc

一. 如何创建一个Springmvc项目

1.导入pom坐标

<dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.10.RELEASE</version>
    </dependency>

2.创建springmvc控制类（等同于servlet功能）

@Controller
public class Usercontriller {
    //设置当前操作路径
    @RequestMapping("/save")
    //设置返回值类型
    @ResponseBody
    public String save(){
        System.out.println("usercontroller save~");
        return "{'moudle','springmvc']";
    }
}

3.初始化springmvc环境等同于spring环境（加载bean）

//3.创建springmvc配置文件加载controller对应bean
@Configuration
@ComponentScan("com.yulong.controller")
public class SpringmvcConfig {
}

4.初始化Servlet容器，加载SpringMVC环境，并设置SpringMVC技术处理的请求

public class ServletinitConfig extends AbstractDispatcherServletInitializer {
    //加载springmvc容器配置
    @Override
    protected WebApplicationContext createServletApplicationContext() {
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        ctx.register(SpringmvcConfig.class);
        return ctx;
    }
    //设置那些请求归属springmvc处理
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //加载spring容器配置
    @Override
    protected WebApplicationContext createRootApplicationContext() {
        return null;
    }
}

5.定义类继承 AbstractDispatcherServletInitializer并实现方法

二.Springmvc注解功能

​

1.排除功能

@ComponentScan(value = “com.yulong”,
excludeFilters = @ComponentScan.Filter
(type = FilterType.ANNOTATION,classes = Controller.class)
)

excludeFilters：排除扫描路径中加载的bean，需要指定类别（type）与具体项（classes） includeFilters：加载指定的bean，需要指定类别（type）与具体项（classes）

2.乱码解决

@Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter chara = new CharacterEncodingFilter();
        chara.setEncoding("utf-8");
        return new Filter[]{chara};
    }

3.请求与响应

1.转换json数据

1.导入pom坐标

<dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
    </dependency>

2.转换json数据

根据业务需求看是要纯文本数据或者转json格式
纯文本：方法体上方不需要@ResponseBody
对象转json：方法体上方需要@ResponseBody

2.请求映射路径

@RequestMapping(“/commonParam”)括号里边内容为访问路径

4.异常处理器

1.定义当前类为异常处理：@RestControllerAdvice

2.在异常处理类方法上发添加@ExceptionAdvice（Exception.class）说明处理所有异常类型`

@RestControllerAdvice
public class ProjectionExciption {
    @ExceptionHandler(Exception.class)
    public Result exceptionHandler(Exception ex){
        return new Result(404,null,"出异常了快去看看~");
    }
}

5.异常的处理

1.添加异常处理器

@RestControllerAdvice
public class ProjectionExciption {

    @ExceptionHandler(SystemException.class)
    public Result doSystemException(SystemException ex){
        //记录日志！
        //发消息给运维
        //发邮件给开发
        return new Result(ex.getCode(),null,ex.getMessage());
    }
    @ExceptionHandler(BusinessException.class)
    public Result doBusinessException(BusinessException ex){

        return new Result(ex.getCode(),null,ex.getMessage());
    }
    @ExceptionHandler(Exception.class)
    public Result doException(Exception ex){

        return new Result(Code.System_UNHNOW_ERR,null,"别着急，等会再来~");
    }
}

对不同种类的异常进行处理

2.定义异常类

public class BusinessException extends RuntimeException{
        private   Integer code;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public BusinessException(Integer code, String message, Throwable cause) {
        super(message, cause);
        this.code = code;
    }

    public BusinessException(Integer code, String message) {
        super(message);
        this.code = code;
    }

}

定义不同的异常类，来进行异常处理

3定义异常编码

public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;
    
    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;

    public static final Integer System_ERR = 50001;
    public static final Integer Business_ERR = 20040;
    public static final Integer System_timeout_ERR = 20040;
    public static final Integer System_UNHNOW_ERR = 59999;

4.触发自定义异常

5.拦截并处理异常

三.request与response接受请求

一.普通参数格式

1.普通参数：请求参数与形参名称对应即可完成参数传递

    @RequestMapping("/commonParam")
    @ResponseBody
    public String commonParam(String name ,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'common param'}";
    }

2.普通参数：请求参数名与形参名不同时，使用@RequestParam注解关联请求参数名称与形参名称之间的关系

    @RequestMapping("/commonParamDifferentName")
    @ResponseBody
    public String commonParamDifferentName(@RequestParam("name") String userName , int age){
        System.out.println("普通参数传递 userName ==> "+userName);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'common param different name'}";
    }

3.POJO参数：请求参数与形参对象中的属性对应即可完成参数传递

    @RequestMapping("/pojoParam")
    @ResponseBody
    public String pojoParam(User user){
        System.out.println("pojo参数传递 user ==> "+user);
        return "{'module':'pojo param'}";
    }

4.嵌套POJO参数：嵌套属性按照层次结构设定名称即可完成参数传递

    @RequestMapping("/pojoContainPojoParam")
    @ResponseBody
    public String pojoContainPojoParam(User user){
        System.out.println("pojo嵌套pojo参数传递 user ==> "+user);
        return "{'module':'pojo contain pojo param'}";
    }

5.数组参数：同名请求参数可以直接映射到对应名称的形参数组对象中

@RequestMapping("/arrayParam")
    @ResponseBody
    public String arrayParam(String[] likes){
        System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
        return "{'module':'array param'}";
    }

6.集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据

    @RequestMapping("/listParam")
    @ResponseBody
    public String listParam(@RequestParam List<String> likes){
        System.out.println("集合参数传递 likes ==> "+ likes);
        return "{'module':'list param'}";
    }

二.json格式接收参数

集合参数：json格式

1.开启json数据格式的自动转换，在配置类中开启@EnableWebMvc
2.使用@RequestBody注解将外部传递的json数组数据映射到形参的保存实体类对象的集合对象中，要求属性名称一一对应

@RequestMapping("/listPojoParamForJson")
    @ResponseBody
    public String listPojoParamForJson(@RequestBody List<User> list){
        System.out.println("list pojo(json)参数传递 list ==> "+list);
        return "{'module':'list pojo for json param'}";
    }

日期参数：json格式

使用@DateTimeFormat注解设置日期类型数据格式，默认格式yyyy/MM/dd

@RequestMapping("/dataParam")
    @ResponseBody
    public String dataParam(Date date,
                            @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                            @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
        System.out.println("参数传递 date ==> "+date);
        System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
        System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
        return "{'module':'data param'}";
    }

四.REST风格

1. REST风格简介

REST表现形式状态转换传统风格资源描述形式：
http://localhost/user/getById?id=1
http://localhost/user/saveUser
REST风格描述形式：
http://localhost/user/1
http://localhost/user
优点：隐藏资源的访问行为，无法通过地址得知对资源是何种操作
书写简化

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http://localhost/users 查询全部用户信息 GET（查询
http://localhost/users/1 查询指定用户信息 GET（查询）
http://localhost/users 添加用户信息 POST（新增/保存）
http://localhost/users 修改用户信息 PUT（修改/更新）
http://localhost/users/1 删除用户信息 DELETE（删除）
根据REST风格对资源进行访问称为RESTful
★★★：上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范
描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如：users、books、accounts……

@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    //@PathVariable注解作用为从{id}里边取值
    public String delete(@PathVariable Integer id){
        System.out.println("user delete id ==> "+id);
        return "{'module':'user delete id'}";
    }

2. RESTful快速开发整理繁琐代码

整理如下：
告别繁琐，使代码更整洁更优雅！

//@Controller
//@ResponseBody
@RestController
@RequestMapping("/user")
public class UserController {
//    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    //@PathVariable注解作用为从{id}里边取值
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        System.out.println("user delete id ==> "+id);
        return "{'module':'user delete id'}";
    }

//    @RequestMapping(value = "/save",method = RequestMethod.POST)
    @PostMapping
    public String save(){
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }

3. RESTful静态页面无法访问

创建一个控制类继承WebMvcConfigurationSupport

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}

让目录脱离spring吗v从管理转交给tomcat，需要访问那些目录按上边代码块中操作进行处理

五.拦截器

1.拦截器使用方法

1.生命拦截器的bean，并实现HandlerInterceptor接口（注意：扫描加载bean）

@Component
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle....");
        return true;
    }
}

2.定义配置类，继承WebMvcConfigrationSupport,实现addInterceptor方法（注意：扫描加载配置）

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");

    }
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books");
    }
}

其中路径可以设置多个用逗号隔开

2.拦截器参数

1.前置处理

@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle....");
        return true;
    }

参数：request:请求对象
response：响应对象
handller：被调用的处理器对象，本质上是一个方法对象，对反射技术的Method对象进行了再包装
返回值：false：被拦截的处理器不再执行

2.后置处理

@Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }

modelAndView：如果处理器完成具有返回结果，可以读取到对应界面信息和数据，并进行调整

3.完成后处理

@Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }

ex：处理器进行中出现的异常现象，可以针对异常情况进行单独处理

3.拦截器链原理

配置方式：复制之前拦截器并重新命名
运行顺序：preHandle：与配置顺序相同，必定运行
postHandle：与配置顺序相反，可能不运行
afterCompletion：与配置顺序相反，可能不运行