通用查询类接口开发的另类思路

一、需求概述

通用查询类接口的需求，在开发过程中是比较常见的一类需求，一般具有以下的特点：

1. 数据更新频率较低
2. 无强制鉴权需求
3. 短时间内数据内容固定

二、开发方式

1、传统开发方式

传统的开发方式，偏向于遵循MVC 模式使用@RestController注解来定义restful接口来进行后续开发。此开发模式大部分开发人员已经司空见惯，驾轻就熟不再详细阐述。

2、将接口视为资源文件

具体做法分为以下几种情况

1.）springmvc工程

springmvc工程配置文件一般为spring-mvc.xml，在此文件添加如下配置指向外部文件目录

	<mvc:resources mapping="/pics/**" location="file:C:\Users\DELL\Pictures\" />

注意：需要以file：绝对文件路径 方式配置

参考项目：https://gitee.com/00fly/java-code-frame/blob/master/springmvc-dbutils/

2.）springboot工程

springboot工程一般以javaCofig代码方式定义资源文件映射

@Slf4j
@Configuration
@ConditionalOnWebApplication
public class WebMvcConfig implements WebMvcConfigurer
{....../*** 加载静态资源文件或文件映射<br>* 映射路径优先级顺序为：META-INF/resources > resources > static > public*/@Overridepublic void addResourceHandlers(final ResourceHandlerRegistry registry){try{registry.addResourceHandler("/pics/**").addResourceLocations("classpath:/data/pic/");registry.addResourceHandler("/upload/**").addResourceLocations("file:" + new File("./upload/").getCanonicalPath() + "/");}catch (IOException e){log.error(e.getMessage(), e);}}

参考项目：https://gitcode.com/00fly/springboot-hello/
示例：https://00fly.online/upload/data.json

3.）nginx代理

nginx代理更方便，只需要在nginx根目录添加文件即可
典型的nginx配置文件如下：
default.conf

server {listen       80;server_name  localhost;#access_log  /var/log/nginx/host.access.log  main;location / {root   /usr/share/nginx/html;index  index.html index.htm;} 
}

我们只需在目录 /usr/share/nginx/html 放入资源文件即可。

示例：http://124.71.129.204/data.json

三、接口数据如何更新

上部分我们已经解决了接口发布和访问的问题，不要忘了：通用查询类接口仍然有数据更新的需求，我们如何来解决这个需求呢？

1、原始数据文件生成接口数据

具体概括为：监听原始数据文件，当数据发生变化时，生成接口数据文件，适用于数据不定期更新，

原始数据：点击获取

1.）定义启动类

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.stream.Collectors;
import java.util.stream.Stream;import org.apache.commons.lang3.StringUtils;import lombok.extern.slf4j.Slf4j;@Slf4j
public class MainRun
{/*** 文件监听程序一直运行* * @param args* @throws IOException*/public static void main(String[] args)throws IOException{// 默认监听项目当前目录String path = new File("").getCanonicalPath();URL url = MainRun.class.getProtectionDomain().getCodeSource().getLocation();if (url.getPath().endsWith(".jar")){log.info("please start jar like: java -jar files-listener-0.0.1.jar --path=/work/test");path = Stream.of(args).filter(arg -> arg.contains("--path")).map(arg -> StringUtils.substringAfter(arg, "=")).collect(Collectors.joining());if (StringUtils.isBlank(path) || !new File(path).exists() || !new File(path).isDirectory()){log.error("please check path is a exist directory!");return;}}FileMonitor.initJsonFilesMonitor(path);}
}

2.）启动监听

import java.io.File;
import java.util.concurrent.TimeUnit;import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.monitor.FileAlterationListenerAdaptor;
import org.apache.commons.io.monitor.FileAlterationMonitor;
import org.apache.commons.io.monitor.FileAlterationObserver;import com.fly.simple.service.JsonDataService;import lombok.extern.slf4j.Slf4j;/*** 监听文件变化*/
@Slf4j
public class FileMonitor
{/*** 初始化文件监听器*/public static void initJsonFilesMonitor(String path){try{log.info("start monitor {} ......", path);FileAlterationObserver observer = new FileAlterationObserver(path, FileFilterUtils.suffixFileFilter(".json"));File dir = new File(path);observer.addListener(new FileAlterationListenerAdaptor(){@Overridepublic void onFileCreate(File file){log.info("★★★★★★★★ {} created.", file.getName());JsonDataService.parseDir(dir);}@Overridepublic void onFileChange(File file){log.info("★★★★★★★★ {} changed.", file.getName());JsonDataService.parseDir(dir);}@Overridepublic void onFileDelete(File file){log.info("★★★★★★★★ {} deleted.", file.getName());JsonDataService.parseDir(dir);}});// 开始监听new FileAlterationMonitor(TimeUnit.SECONDS.toMillis(10), observer).start();}catch (Exception e){log.error(e.getMessage(), e.getCause());}}
}

3.）文件处理

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.ResourceBundle;
import java.util.stream.Collectors;import org.apache.commons.io.FileUtils;import com.fly.simple.entity.Article;
import com.fly.simple.entity.BlogData;
import com.fly.simple.utils.JsonBeanUtils;import lombok.extern.slf4j.Slf4j;/*** JsonData服务类*/
@Slf4j
public class JsonDataService
{private static File dir = new File(ResourceBundle.getBundle("config").getString("out"));public static void parseDir(File directory){try{// 遍历目录下json文件Collection<File> files = FileUtils.listFiles(directory, new String[] {"json"}, false);List<Article> data = files.stream().map(f -> parseToArticles(f)).flatMap(List::stream).distinct().collect(Collectors.toList());FileUtils.writeStringToFile(dir, JsonBeanUtils.beanToJson(data, true), StandardCharsets.UTF_8, false);log.info("articles length : {}", data.size());}catch (IOException e){log.error(e.getMessage(), e);}}/*** 解析File为List* * @param resource* @return*/private static List<Article> parseToArticles(File file){try{String jsonData = FileUtils.readFileToString(file, StandardCharsets.UTF_8);return JsonBeanUtils.jsonToBean(jsonData, BlogData.class, true).getData().getList();}catch (IOException e){log.error(e.getMessage(), e);return Collections.emptyList();}}
}

4.） 完整代码

https://gitee.com/00fly/effict-side/tree/master/files-listener

2、借助crontab定时执行

具体概括为：按照设定时间点生成接口数据文件，适用于数据固定周期更新

files-listener项目根目录执行打包

mvn clean package -f pom-json.xml

执行后会在target文件目录生成files-listener-0.0.1.jar，将jar上传到服务器目录如：/work/files-listener-0.0.1.jar后
命令行执行

#查看定时任务
crontab -l#编辑定时任务
crontab -e

编辑时输入以下内容

0 */12 * * * java -jar /work/files-listener-0.0.1.jar

此命令实现，每12小时执行一次Jar

不再详细阐述，实现思路具体请查阅文章：服务器docker应用一览

---

有任何问题和建议，都可以向我提问讨论,大家一起进步，谢谢!

-over-