springMVC 开发远程服务端API接口，ip白名单过滤器，客户端请求实例
需求：
1 实现用springMVC 开发API 接口
2 服务端实现白名单功能，也就是写一个过滤器只允许白名单配置的机器才能访问这个API接口
3 post 请求实现
4 服务端接收json格式的数据请求，并返回 json格式数据结果集
5 客户端实现调用服务端接口
6 这是一个maven 项目
详解：
一 ，pom.xml
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>ezrWeb</groupId>
<artifactId>ezr-web-addBrand</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>ezr-web-addBrand Maven Webapp</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>javaee</groupId>
<artifactId>javaee-api</artifactId>
<version>5</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>4.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>4.1.9.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>4.2.1.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>4.1.9.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>4.3.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>4.1.9.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.1.9.RELEASE</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.2.2</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.17.1-GA</version>
</dependency>
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.27</version>
</dependency>
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.3</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.8.8</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.8</version>
</dependency>
<dependency>
<groupId>commons-pool</groupId>
<artifactId>commons-pool</artifactId>
<version>1.6</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.1</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.7.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.7.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.7.4</version>
</dependency>
<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>20180813</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.28</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.6</version>
</dependency>
</dependencies>
<build>
<finalName>ezr-web-addBrand</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.6</source>
<target>1.6</target>
</configuration>
</plugin>
</plugins>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
</project>
二，web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
<display-name>EzrWebAddBrand</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<filter>
<filter-name>FilterIP</filter-name>
<filter-class>ezr.bd.filter.FilterIP</filter-class>
<init-param>
<param-name>FilteredIP</param-name>
<param-value>192.168.XX.xx,192.168.xx.xxx</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>FilterIP</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-*.xml</param-value>
</context-param>
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
<filter>
<filter-name>characterEncodingFilter</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>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>三，过滤器：
package ezr.bd.filter;
import javax.servlet.*;
import java.io.IOException;
/**
* Created by liucf on 2019/3/7.
* 这是一个针对IP进行过滤的自定义过滤器
* 只允许在web.xml 中配置了的IP允许访问接口
*/
public class FilterIP implements Filter{
protected String fip = ""; //要过滤的IP
protected FilterConfig fcon = null;//过滤器配置对象
/**
* 初始化
* @param config
* @throws ServletException
*/
@Override
public void init(FilterConfig config) throws ServletException {
System.out.println("FilterIP 过滤器初始化");
this.fcon = config;
fip = fcon.getInitParameter("FilteredIP");//和web.xml 的 filter
if (fip == null) {
fip = "";
}
System.out.println("要过滤的IP地址为:" + fip);
}
/**
* 过滤方法
* 只允许在web.xml 中配置了的IP允许访问接口，否则不能访问。
* @param request 请求对象
* @param response 相应对象
* @param chain 过滤对象
* @throws IOException
* @throws ServletException
*/
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("FilterIP 过滤器执行过滤方法");
response.setContentType("text/html");
response.setCharacterEncoding("utf-8");
// 得到请求的IP地址 和要过滤的Ip地址进行对比
String ip = request.getRemoteAddr();
System.out.println("fip： "+fip);
System.out.println("ip： "+ip);
if (fip.contains(ip)) {
// 发现配置中允许的ip
chain.doFilter(request, response);
} else{
// 未在web.xml中配置的ip
String path = "error.do";
RequestDispatcher desc = request.getRequestDispatcher(path);
desc.forward(request, response);
}
}
@Override
public void destroy() {
System.out.println("FilterIP 过滤器销毁");
this.fcon = null;
}
}
服务端 只接受 post 请求 和 json参数的API 接口
package ezr.bd.controller;
import com.alibaba.fastjson.JSON;
import ezr.bd.biz.OptBdMonitorShardGrpCompletedBiz;
import ezr.bd.model.CompletedShardGrp;
import org.apache.commons.io.IOUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
/**
* Created by liucf on 2019/3/11.
*/
@Controller
@RequestMapping("getCompletedShardGrp.do")
public class OptBdMonitorShardGrpCompletedController {
@Autowired
private OptBdMonitorShardGrpCompletedBiz optBdMonitorShardGrpCompletedImpl;
@RequestMapping(params = "listTest",produces = "application/json",method = RequestMethod.POST)
@ResponseBody
public Map<String,Object> getCompletedShardGrpTest(HttpServletRequest request, HttpServletResponse response)throws Exception {
Map<String, Object> responseMap = new HashMap<String, Object>();//用来存接口返回信息
try{
String data= IOUtils.toString(request.getInputStream());//获取传入的json
Map<String, Object> requsetMap = new HashMap<String, Object>();//用来保存接口请求信息
System.out.println("传来的Json是：" + data);
requsetMap = JSON.parseObject(data);//把json转成map
System.out.println("打印requsetMap："+requsetMap.toString());
String lastCheckTime = requsetMap.get("lastCheckTime").toString();
System.out.println("打印requsetMap lastCheckTime："+lastCheckTime);
ArrayList<CompletedShardGrp> list = optBdMonitorShardGrpCompletedImpl.selectCompletedShardGrp();
if (null != list && !list.isEmpty()){
responseMap.put("data", list);
}
//一般做接口开发，都会用到下面两个，一个是code代表你的接口状态，第二是msg，代表接口的情况
responseMap.put("code", "0");//状态码
responseMap.put("msg", "请求成功");//信息描述
}catch (Exception e){
}
return responseMap;
}
@RequestMapping(params = "list",produces = "application/json",method = RequestMethod.POST)
@ResponseBody
public Map<String,Object> getCompletedShardGrp(HttpServletRequest request, HttpServletResponse response)throws Exception {
Map<String, Object> responseMap = new HashMap<String, Object>();//用来存接口返回信息
try{
String data= IOUtils.toString(request.getInputStream());//获取传入的json
Map<String, Object> requsetMap = new HashMap<String, Object>();//用来保存接口请求信息
System.out.println("传来的Json是：" + data);
requsetMap = JSON.parseObject(data);//把json转成map
System.out.println("打印requsetMap："+requsetMap.toString());
String lastCheckTime = requsetMap.get("lastCheckTime").toString();
System.out.println("打印requsetMap lastCheckTime："+lastCheckTime);
ArrayList<CompletedShardGrp> list = optBdMonitorShardGrpCompletedImpl.getCompletedShardGrp(lastCheckTime);
if (null != list && !list.isEmpty()){
responseMap.put("data", list);
}
//一般做接口开发，都会用到下面两个，一个是code代表你的接口状态，第二是msg，代表接口的情况
responseMap.put("code", "0");//状态码
responseMap.put("msg", "请求成功，数据正常");//信息描述
}catch (Exception e){
responseMap.put("data", "");
responseMap.put("code", "1");//状态码
responseMap.put("msg", "请求失败，无数据返回");//信息描述
e.printStackTrace();
}
return responseMap;
}
}
四，客户端请求实例
package ezr.bd.controller;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.StatusLine;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.utils.HttpClientUtils;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
@SuppressWarnings("deprecation")
public class HttpClientTest{
/**
* post提交调用方法
* 亲测过
* @param jsonParams post 请求的json 字符串
* @param apiUrl post 请求的 apiUrl
* @return return 回去一个 json 字符串
* @throws UnsupportedEncodingException 抛出异常类型：不支持字符编码
*/
public static String callRemotePostApi(String jsonParams,String apiUrl) throws UnsupportedEncodingException{
System.out.println(jsonParams);
/**创建httpClient实例对象*/
CloseableHttpClient httpClient = HttpClients.createDefault();
/**创建httpPost实例对象*/
HttpPost httpPost = new HttpPost(apiUrl);
httpPost.setEntity(new StringEntity(jsonParams, Charset.forName("utf-8")));
BufferedReader reader = null;
StringBuffer sb = new StringBuffer();
try {
HttpResponse response = httpClient.execute(httpPost);
int statusCode = response.getStatusLine().getStatusCode();
System.out.println(statusCode);
if(statusCode==200){//请求和响应都成功了
/**
* 调用HttpResponse的getEntity()方法可获取HttpEntity对象，
* 该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
*/
HttpEntity entity = response.getEntity();
reader = new BufferedReader(new InputStreamReader(entity.getContent(),"UTF-8"));
String buffer = "";
while ((buffer=reader.readLine())!=null){
sb.append(buffer);
}
}
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
if(reader != null){
reader.close();
}
httpPost.releaseConnection();
/**关闭此连接管理器并释放分配的资源*/
httpClient.getConnectionManager().shutdown();
/**无条件地关闭httpClient。关闭基础连接管理器并释放资源*/
HttpClientUtils.closeQuietly(httpClient);
} catch (IOException e){
e.printStackTrace();
}
}
return sb.toString();
}
public static void main(String[] args) throws Exception {
String jsonParams = "{\"lastCheckTime\":\"2019-03-07 21:15:14\"}";
String apiUrl = "http://192.168.XX.XX:8080/getCompletedShardGrp.do?list";
String str = callRemotePostApi(jsonParams,apiUrl);
System.out.println(str);
}
}
五，postman测试：
六，后端客户端测试：
{"lastCheckTime":"2019-03-07 21:15:14"}
200
{"msg":"请求成功，数据正常","code":"0","data":[{"id":"20190307-1","shardingGrpId":"1","lastModifyDate":"2019-03-07 21:15:14.0"},{"id":"20190311-12","shardingGrpId":"1212","lastModifyDate":"2019-03-11 18:05:09.0"},{"id":"20190311-13","shardingGrpId":"1313","lastModifyDate":"2019-03-11 18:06:31.0"}]}
Process finished with exit code 0
其他部分省略