SpringMVC(精简版)_springmvc 最简-CSDN博客

本文链接：https://blog.csdn.net/weixin_46163707/article/details/123997561

一、配置文件

1.引入依赖

    <dependencies>
        <!-- SpringMVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>
        <!-- 日志 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- ServletAPI -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
        <!-- Spring5和Thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.12.1</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.12.1</version>
        </dependency>
        <!--       用于文件上传 -->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>
        
    </dependencies>

2、创建初始化类

WebInit：

public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer{
    //指定spring的配置类
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }
    //指明SpringMVC的配置类在哪里
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }
    /*
     * 指定DispatcherServlet的映射规则，即url-pattern
     *相当于
     * <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
     * </servlet-mapping>
     */
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //添加过滤器
    @Override
    protected Filter[] getServletFilters() {
        //解决乱码
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        characterEncodingFilter.setForceEncoding(true);
        //实现PUT,DELETE请求方式
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{characterEncodingFilter,hiddenHttpMethodFilter};
    }
}

webConfig：

/**
 * 代替SpringMVC的配置文件：
 * 1、扫描组件   2、视图解析器     3、view-controller    4、default-servlet-handler
 * 5、mvc注解驱动    6、文件上传解析器   7、异常处理      8、拦截器
 */
//将当前类标识为一个配置类
@Configuration
/*
 *1.扫描组件
 *相当于springmvc中的
 *<context:component-scan base-package="com.example"></context:component-scan>
 */
@ComponentScan("com.example")
/*
  5.开启MVC注解驱动<mvc:annotation-driven/>
    作用① 跟view-controller一起使用
        ②可以将响应到浏览器的Java对象转换为Json格 式的字符串
        ③跟开启静态资源处理一起使用
 */
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    /*
   4.开启静态资源处理
   <!--    静态资源处理-->
   <mvc:default-servlet-handler/>
    */
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    /*
    8.拦截器
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/testRequestBody"/>
            <ref bean="firstInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        FirstInterceptor firstInterceptor = new FirstInterceptor();
        registry.addInterceptor(firstInterceptor).addPathPatterns("/**");
    }

    /*3、view-controller
    当SpringMVC中设置任何一个view-controller时，其他控制器中的请求映射将全部失效，此时需
    要在SpringMVC的核心配置文件中设置开启mvc注解驱动的标签：
    */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }

    /*
    6.配置文件上传解析器
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    </bean>
     */
    @Bean
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
        return commonsMultipartResolver;
    }

    //7、异常处理
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        //Properties继承hashtable ，但是Properties只能操作字符串类型的键和值，所以不能用put/get方法
        prop.setProperty("java.lang.ArithmeticException", "error");
        exceptionResolver.setExceptionMappings(prop);
        //将错误信息 赋值给exception
        exceptionResolver.setExceptionAttribute("exception");
        resolvers.add(exceptionResolver);
    }

    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver需要一个ServletContext作为构造参数，可通过WebApplicationContext 的方法获得
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(
                webApplicationContext.getServletContext());
        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;
    }

    //生成模板引擎并为模板引擎注入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //生成视图解析器并未解析器注入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

}

二、各种注解整理

1、@RequestMapping注解

作用：标识一个类：设置映射请求的请求路径的初始信息

标识一个方法：设置映射请求请求路径的具体信息

@RequestMapping(value = {"/"},method = {RequestMethod.POST},params = {"username"})

2、@PathVariable

作用：与占位符一起使用，使形参与占位符中的变量对应


@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username") String username){}

3、@RequestParam

作用：将@RequestParam 的value中的对应的请求参数的值赋值给后面的形参

注：若required设置为true时，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置 defaultValue属性，则页面报错400：Required String parameter 'xxx' is not present；若设置为 false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的默认值，没有设默认值则为 null

@RequestParam(value = "user_name",required=false,defaultValue = "SHD" String UID)

4、@RequestHeader

作用：@RequestHeader 的value中的对应的请求参数的值赋值给后面的形参，一共有三个属性：value、required、defaultValue，用法同@RequestParam

注：value的值只能写host/Host

@RequestHeader(value = host", required = true) String host

5、@CookieValue

作用：@CookieValue 的value中的对应的请求参数的值赋值给后面的形参，一共有三个属性：value、required、defaultValue，用法同@RequestParam

注：写法固定

@CookieValue("JSESSIONID") String JSESSIONID

6、@RequestBody

作用：将@RequestBody 的value中的对应的请求参数的值赋值给后面的形参

7、@ResponseBody

作用：@ResponseBody用于标识一个控制器方法，可以将该方法的返回值直接作为响应报文的响应体响应到浏览器，直接在浏览器显示


@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody(){
    return "success";
}

8、@RestController注解

作用：@RestController注解是springMVC提供的一个复合注解，标识在控制器的类上，就相当于为类添加了 @Controller注解，并且为其中的每个方法添加了@ResponseBody注解