java生成spring mvc接口文档

转载

架构师之光 2024-11-28 11:11:34

文章标签 spring mvc java spring xml mvc 文章分类 Java 后端开发

概述

Spring MVC是目前主流的实现MVC设计模式的企业级开发框架，是Spring 框架的子模块，无需整合

一、MVC设计模式

将应用程序分为三部分

java生成spring mvc接口文档_spring mvc

二、核心组件

DispatcherServlet：前置控制器，是整个流程控制的核心，控制其他组件的执行，进行统一调度，降低组件之间的耦合性，相当于总指挥。
Handler：处理器，完成具体的业务逻辑，相当于 Servlet 或 Action。
HandlerMapping：DispatcherServlet 接收到请求之后，通过 HandlerMapping 将不同的请求映射到不同的 Handler。
HandlerInterceptor：处理器拦截器，是一个接口，如果需要完成一些拦截处理，可以实现该接口。
HandlerExecutionChain：处理器执行链，包括两部分内容：Handler 和HandlerInterceptor（系统会有一个默认的 HandlerInterceptor，如果需要额外设置拦截，可以添加拦截器）。
HandlerAdapter：处理器适配器，Handler 执行业务方法之前，需要进行一系列的操作，包括表单数据的验证、数据类型的转换、将表单数据封装到 JavaBean 等，这些操作都是由 HandlerAdapter 来完成，开发者只需将注意力集中在业务逻辑的处理上，DispatcherServlet 通过 HandlerAdapter 执行不同的 Handler。
ModelAndView：装载了模型数据和视图信息，作为 Handler 的处理结果，返回 DispatcherServlet。
ViewResolver：视图解析器，DispatcherServlet 通过它将逻辑视图解析为物理视图，最终将渲染结果响应给客户端。

三、工作流程

客户端请求被 DispatcherServlet 接收。
根据 HandlerMapping 映射到 Handler。
生成 Handler 和 HandlerInterceptor。
Handler 和 HandlerInterceptor 以 HandlerExecutionChain 的形式一并返回给DispatcherServlet。
DispatcherServlet 通过 HandlerAdapter 调用 Handler 的方法完成业务逻辑处理。
Handler 返回一个 ModelAndView 给 DispatcherServlet。
DispatcherServlet 将获取的 ModelAndView 对象传给 ViewResolver 视图解析器器，将逻辑视图解析为物理理视图 View。
ViewResovler 返回一个 View 给 DispatcherServlet。
DispatcherServlet 根据 View 进行视图渲染（将模型数据 Model 填充到视图 View 中）。
DispatcherServlet 将渲染后的结果响应给客户端。

四、SpringMVC工程创建步骤

新建maven工程，选择webapp，配置pom,xml

<dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.7.RELEASE</version>
    </dependency>
  </dependencies>

在web,xml中配置DispatcherServlet

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name> contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

在resources中新建springmvc.xml，并配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">
        
    <!-- 自动扫描 -->
    <context:component-scan base-package="com.lin"></context:component-scan>
    <!-- 配置视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>
    
</beans>

测试handler类

@Controller
public class HelloHandler {
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello World");
        // 调转到hello.jsp中
        return "hello";
    }
}

五、解决中文乱码

（1）解决中文乱码

<filter>
    <filter-name>encodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>UTF-8</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

（2）解决@ResponseBody中文乱码

<mvc:annotation-driven>
    <!-- 消息转换器 -->
    <mvc:message-converters register-defaults="true">
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="supportedMediaTypes" value="text/html;charset=UTF-8"></property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

六、无法加载静态资源

在web.xml中配置

<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.css</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.jpg</url-pattern>
  </servlet-mapping>

七、数据绑定

完成映射，类型转换等工作都由HandlerAdapter完成

（1）传统方式

@Controller ：在类定义处添加，将该类交给IoC容器（在xml文件中配置自动扫描），称为一个控制器，可以接收请求
@ResponseBody ：在方法处添加，会直接将业务方法的返回值响应给客户端
@RestController ：在类定义出添加，相当于@Controller+@ResponseBody，表示直接将业务方法返回值交给客户端，不进行视图解析
@RequestMapping ：在类定义处或方法处添加，将URL与业务方法进行映射

vlaue：指定URL
method：请求类型
params：请求中必须包含指定参数

@RequestParam ：在参数列表中添加，将http请求参数与业务方法形参绑定。相同名称则不需要添加

value ：参数绑定
required ：是否为必填项，true 为必填，false表示非必填
defalutValue ：默认值

@RequestMapping(value = "/a",params = {"name=a"})
    public String hello1(String name){
        return name;
    }
    @RequestMapping(value = "/b",params = {"name=b"})
    public String hello2(@RequestParam("name") String age){
        return age;
    }

（2）RESTful 风格URL

上述传统URL：http://localhost:8080/hello?name=abc
REST：http://localhost:8080/hello/abc

@RequestMapping("/hello/{name}")
    public String rest(@PathVariable("name") String name){
        System.out.println(name);
        return "hello";
    }

@PathVariable ：在参数列表处添加，完成URL与参数的映射

（3）映射Cookie

可以直接在业务方法中获取Cookie的值

@RequestMapping("/cookie")
public String cookie(@CookieValue(value = "JSESSIONID") String sessionId){
System.out.println(sessionId);
return "hello";
}

（4）使用javaBean绑定参数

会根据请求参数名和 JavaBean 属性名进行自动匹配，自动为对象填充属性值，同时支持级联属性。

@RequestMapping("/login")
    public String post(Person person){
        System.out.println(person);
        return "login";
    }

@Data
public class Person {
    private String name;
    private Number number;
}

@Data
public class Number {
    private String telNumber;
}

<body>
    <form action="/login">
        <input name="name">
        <input name="number.telNumber">
        <input type="submit" value="提交">
    </form>
</body>

（5）JSP转发和重定向

默认为转发

return "forward:/login.jsp";
// 等价于
return "login";

重定向

return "redirect:/login.jsp";

（6）数组

@RequestMapping("/array")
    @ResponseBody
    public String array(String[] list){
        String s = Arrays.toString(list);
        return s;
    }

（7）List集合

Spring MVC 不支持 List 类型的直接转换，需要对 List 集合进行包装。（无法对对象赋值，只能对属性赋值）

@RequestMapping("/list")
    public String test1(UserList list) {
        StringBuffer stringBuffer = new StringBuffer();
        for (Person person : list.getList()) {
            stringBuffer.append(person);
        }
        return stringBuffer.toString();
    }

@Data
public class UserList {
    List<Person> list;
}

@Data
public class Person {
    private String name;
    private Number number;
}

@Data
public class Number {
    private String telNumber;
}

<body>
    <form action="/list">
        <input name="list[0].name">
        <input name="list[0].number.telNumber">
        <input name="list[1].name">
        <input name="list[1].number.telNumber">
        <input type="submit" value="提交">
    </form>
</body>

（8）Map集合

与List集合同理

@RequestMapping("/map")
    public String test2(UserMap userMap){
        StringBuffer stringBuffer = new StringBuffer();
        for (String key:userMap.getMap().keySet()){
            Person value = userMap.getMap().get(key);
            stringBuffer.append(value);
        }
        return stringBuffer.toString();
    }

<body>
    <form action="/map">
        <input name="map['a'].name">
        <input name="map['a'].number.telNumber">
        <input name="map['b'].name">
        <input name="map['b'].number.telNumber">
        <input type="submit" value="提交">
    </form>
</body>

（9）JSON

客户端发送 JSON 格式的数据，直接通过 Spring MVC 绑定到业务方法的形参中。

配置web,xml，使其支持静态资源
配置pom,xml导入包

<dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.68</version>
    </dependency>

在springmvc.xml中配置json

<!-- 配置JSON -->
<bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">

java生成spring mvc接口文档_spring mvc_02

controller

@RequestMapping("/json")
    public Person json(@RequestBody Person user){
        System.out.println(user);
        user.setName("修改后");
        return user;
    }

<head>
    <title>Title</title>
    <script type="text/javascript" src="js/jquery-1.7.2.min.js"></script>
    <script type="text/javascript">
        $(function(){
            var user = {
                "name":"修改前",
            };
            $.ajax({
                url:"/json",
                data:JSON.stringify(user),
                type:"POST",
                contentType:"application/json;charset=UTF-8",
                dataType:"JSON",
                success:function(data){
                    alert(data.name);
                }
            })
        });

    </script>
</head>

八、自定义数据转换器

数据转换：将Http请求中的参数转换为业务方法中定义的形参，HandlerAdapter已经提供了一些通用的转换（Stirng转int，表单数据封装等），但特殊业务需要用户自定义转换器

（1）String转日期

public class DateConverter implements Converter<String, Date> {
    private String pattern;

    public DateConverter(String pattern) {
        this.pattern = pattern;
    }
    @Override
    public Date convert(String s) {
        SimpleDateFormat format = new SimpleDateFormat(pattern);
        Date date = null;
        try {
            date = format.parse(s);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return date;
    }
}

<!-- 配置自定义转换器 -->
    <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
        <property name="converters">
            <list>
                <bean class="com.lin.converter.DateConverter">
                    <constructor-arg value="yyyy-MM-dd"></constructor-arg>
                </bean>
            </list>
        </property>
    </bean>
    
    <!-- 在这里还需要添加conversion-service-->
    <mvc:annotation-driven conversion-service="conversionService">

@RestController
public class ConverterHandler {
    @RequestMapping("convert")
    public String converter(Date date){
        return date.toString();
    }
}

（2）String转People

与表单封装不一样，这里是在一个框中输入类似“15+张三+30”（使用+分隔）

public class PeopleConverter implements Converter<String, People> {

    @Override
    public People convert(String s) {
        String[] split = s.split("\\+");
        People people = new People();
        people.setId(Integer.parseInt(split[0]));
        people.setName(split[1]);
        people.setAge(Integer.parseInt(split[2]));
        return people;
    }
}

<!-- 配置自定义转换器 -->
    <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
        <property name="converters">
            <list>
                <bean class="com.lin.converter.DateConverter">
                    <constructor-arg value="yyyy-MM-dd"></constructor-arg>
                </bean>
                <bean class="com.lin.converter.PeopleConverter"></bean>
            </list>
        </property>
    </bean>
    <mvc:annotation-driven conversion-service="conversionService">

@RequestMapping("/convert1")
    public String converter(People people){
        return people.toString();
    }

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：Java创建表的规则

下一篇：自建MAVEN 需要多大空间

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯