spring mvc - tutorial 1：实现简单的GET、POST接口并使用Postman测试

本次尝试创建一个简单的spring mvc restful项目，尝试简单的接口实现。
工具使用：intellij IDEA
Spring：当前最新版本5.0.5RELEASE
Spring就是各大杂烩，啥东西都可以被加进去，比如data-bind，rabbitmq，mybatis, swagger等等，几乎各种流行的库都被它搞了一把，和spring集成到一起，用起来比较方便，但配置和学习起来比较麻烦，个人并不怎么喜欢，所以一直也没有去实践一把。这次闲来无事就玩玩。

1. intellij IDEA创建一个maven web app

创建项目没什么好说的，非常简单。主要是需要各种配置，这就是spring不好玩的地方，简直乱糟糟。

1.1 POM添加依赖

依赖包含3部分：spring相关库，spring mvc相关库，以及数据绑定相关的库。

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>example</groupId>
  <artifactId>example1</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>example1 Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>

    <spring.version>5.0.5.RELEASE</spring.version>
    <jackson.version>2.9.5</jackson.version>
  </properties>

  <dependencies>
    <!-- spring -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jms</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-oxm</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aop</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <!-- spring MVC -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <!-- jackson 用于实现spring mvc数据绑定，这样接口的json对象可以直接被转换成java对象 -->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>${jackson.version}</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>${jackson.version}</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>${jackson.version}</version>
    </dependency>

  </dependencies>
  ...
</project>

1.2 添加spring和spring mvc配置文件

研究了一下，默认这些配置文件都放在：src\main\webapp\WEB-INF目录下。那么这里我们就在这个目录下创建对应的配置文件好了，配置文件如下：

applicationContext.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"
       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">

    <!-- Spring bean配置 -->
    <context:component-scan base-package="example.model" />

</beans>

dispatcher-servlet.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:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context" 
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/mvc 
       http://www.springframework.org/schema/mvc/spring-mvc.xsd 
       http://www.springframework.org/schema/context 
       http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 使用注解驱动Spring MVC -->
    <mvc:annotation-driven/>

    <!-- 定义扫描的包，用以加载对应的控制器和其它一些组件 -->
    <context:component-scan base-package="example.controller"/>

    <!-- 定义视图解析器，解析器中定义了前缀和后缀，这样视图就知道去Web工程的/WEB-INF/jsp文件夹中找到对应的jsp文件作为视图响应用户请求-->
    <!-- 找Web工程/WEB-INF/jsp文件夹，且文件结尾为jsp的文件作为映射 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/jsp/" p:suffix=".jsp"/>

</beans>

1.3 配置web.xml

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>

  <!-- 配置Spring IoC配置文件的路径，其默认值为/WEB-INF/applicationContext.xml -->
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/applicationContext.xml</param-value>
  </context-param>

  <!-- 配置ContextLoaderListener用以初始化Spring IoC -->
  <!-- ContextLoaderListener实现了ServletContextListener接口；ServletContextListener的作用是可以在整个Web工程前后加入自定义代码，
  从而使得我们可以在Web工程初始化之前，完成对Spring IoC容器的初始化，也可以在Web关闭时完成Spring IoC容器资源的释放 -->
  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

  <!-- 配置DispatcherServlet -->
  <!-- 配置了servlet-name为dispatcher，这意味着需要一个/WEB-INF/dispatcher-servlet.xml的文件与之对应 -->
  <servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
    </init-param>
    <!-- 在服务器启动时就初始化 -->
    <load-on-startup>2</load-on-startup>
  </servlet>

  <!-- Servlet拦截配置 -->
  <servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

通过上面一大把配置，基本框架算是建立起来了，可以开始写代码了。整个创建过程体验不适很爽。如果idea可以一键配置就好了。

2. 添加controller和model

在src/main/java下添加包example.controller用于放controller 和包example.model用于放model就是POJO类。

package example.model;

public class User {
    private int id;
    private String name;

    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;
    }
}

package example.controller;


import example.model.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
@RequestMapping("/ex")
public class MyController {

    /**
     * 接收一个字符串，返回一个字符串
     * @param name
     * @return 
     */
    @ResponseBody
    @RequestMapping(value="user1")
    public String getUser1(@RequestParam(value = "name") String name){
        return "you put a string: " + name;
    }

    /**
     * 输入json，经过springmvc数据绑定直接映射成了java对象
     * @param user
     * @return json，java对象会自动转换成json字符串
     */
    @ResponseBody
    @RequestMapping(value="user2", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
    public User getUser2(@RequestBody User user){
        return user;
    }
}

3. 配置tomcat运行

用默认配置即可。

3.1 GET方法测试

这个直接用浏览器测试即可，比如浏览器中输入：
http://localhost:8080/ex/user1?name=abc
这里写图片描述

3.2 POST方法测试

这里用Postman
这里写图片描述