當(dāng)前位置：首頁 > 运维知识 > 数据库 >内容正文

数据库

用Elasticsearch代替数据库存储日志方式

發(fā)布時(shí)間：2023/12/10 数据库 38 豆豆

生活随笔收集整理的這篇文章主要介紹了用Elasticsearch代替数据库存储日志方式小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

之前的項(xiàng)目中一直使用的是數(shù)據(jù)庫表記錄用戶操作日志的，但隨著時(shí)間的推移，數(shù)據(jù)庫log單表是越來越大「不考慮刪除」，再加上近期項(xiàng)目中需要用到Elasticsearch，所以干脆把這些用戶日志遷移到ES上來了。

環(huán)境：SpringBoot2.2.6 + Elasticsearch6.8.8

如果你還不了解Elasticsearch的話，可以參考之前的幾篇文章：

ES基本概念：https://www.cnblogs.com/niceyoo/p/10864783.html

重溫ES基礎(chǔ)：https://www.cnblogs.com/niceyoo/p/11329426.html

ES-Windows集群搭建：https://www.cnblogs.com/niceyoo/p/11343697.html

ES-Docker集群搭建：https://www.cnblogs.com/niceyoo/p/11342903.html

MacOS中ES搭建：https://www.cnblogs.com/niceyoo/p/12936325.html

由于之前就是使用的AOP+注解方式實(shí)現(xiàn)日志記錄，而本次依舊采用這種方式，所以改動(dòng)不大，把保存至數(shù)據(jù)庫換成ES就可以了，開始吧。

文章最后我會(huì)提供源碼的，正文描述部分有省略~

1、引入依賴文件

pom.xml文件中引入需要的es、aop所需的依賴：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.6.RELEASE</version><relativePath/> </parent><groupId>com.example</groupId><artifactId>demo</artifactId><version>0.0.1-SNAPSHOT</version><name>demo</name><description>Demo project for Spring Boot</description><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope><exclusions><exclusion><groupId>org.junit.vintage</groupId><artifactId>junit-vintage-engine</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-elasticsearch</artifactId></dependency><dependency><groupId>com.google.code.gson</groupId><artifactId>gson</artifactId><version>2.8.6</version></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>5.3.2</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build> </project>

2、修改yml配置文件

加入elasticsearch的配置信息：

server:port: 6666servlet:context-path: /tomcat:uri-encoding: UTF-8spring:# Elasticsearchdata:elasticsearch:client:reactive:# 要連接的ES客戶端多個(gè)逗號(hào)分隔endpoints: 127.0.0.1:9300# 暫未使用ES 關(guān)閉其持久化存儲(chǔ)repositories:enabled: true

3、Log實(shí)體

使用了lombok「 @Data 注解」簡(jiǎn)化 set\get，spring-data-elasticsearch提供了@Document、@Id、@Field注解，其中@Document作用在實(shí)體類上，指向文檔地址，@Id、@Field作用于成員變量上，分別表示主鍵、字段。

@Data @Document(indexName = "log", type = "log", shards = 1, replicas = 0, refreshInterval = "-1") public class EsLog implements Serializable{private static final long serialVersionUID = 1L;/*** 主鍵*/@Idprivate String id = SnowFlakeUtil.nextId().toString();/*** 創(chuàng)建者*/private String createBy;/*** 創(chuàng)建時(shí)間*/@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")@Field(type = FieldType.Date, index = false, format = DateFormat.custom, pattern = "yyyy-MM-dd HH:mm:ss")private Date createTime = new Date();/*** 時(shí)間戳查詢時(shí)間范圍時(shí)使用*/private Long timeMillis = System.currentTimeMillis();/*** 方法操作名稱*/private String name;/*** 日志類型*/private Integer logType;/*** 請(qǐng)求鏈接*/private String requestUrl;/*** 請(qǐng)求類型*/private String requestType;/*** 請(qǐng)求參數(shù)*/private String requestParam;/*** 請(qǐng)求用戶*/private String username;/*** ip*/private String ip;/*** 花費(fèi)時(shí)間*/private Integer costTime;/*** 轉(zhuǎn)換請(qǐng)求參數(shù)為Json* @param paramMap*/public void setMapToParams(Map<String, String[]> paramMap) {this.requestParam = ObjectUtil.mapToString(paramMap);} }

4、Dao層

數(shù)據(jù)操作層，有兩種方式實(shí)現(xiàn)對(duì)Elasticsearch數(shù)據(jù)的修改，一是使用ElasticsearchTemplate，二是通過ElasticsearchRepository接口，本文基于后者接口方式。

用過SpringDataJPA的小伙伴就不陌生了，如下實(shí)現(xiàn)接口就跟JPA通過方法名稱生成SQL一樣簡(jiǎn)單。

/*** esc dao*/ public interface EsLogDao extends ElasticsearchRepository<EsLog, String> {/*** 通過類型獲取* @param type* @return*/Page<EsLog> findByLogType(Integer type, Pageable pageable); }

默認(rèn)情況下，ElasticsearchRepository提供了findById()、findAll()、findAllById()、search()等方法供我們方便使用。

5、自定義注解

自定義 @SystemLog 注解，用于標(biāo)記需要記錄日志的方法。

@Target({ElementType.PARAMETER, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface SystemLog {/*** 日志名稱* @return*/String description() default "";/*** 日志類型* @return*/LogType type() default LogType.OPERATION; }

6、編寫切面、通知

步驟5中自定義了注解，那么接下來就是定位注解，以及對(duì)定位后的方法進(jìn)行業(yè)務(wù)處理部分了，而對(duì)我們來說就是把日志記錄至Elasticsearch中。

/*** 日志管理*/ @Aspect @Component @Slf4j public class SystemLogAspect {private static final ThreadLocal<Date> beginTimeThreadLocal = new NamedThreadLocal<Date>("ThreadLocal beginTime");@Autowiredprivate EsLogService esLogService;@Autowired(required = false)private HttpServletRequest request;/*** Controller層切點(diǎn),注解方式*/@Pointcut("@annotation(com.example.demo.annotation.SystemLog)")public void controllerAspect() {}/*** 前置通知 (在方法執(zhí)行之前返回)用于攔截Controller層記錄用戶的操作的開始時(shí)間* @param joinPoint 切點(diǎn)* @throws InterruptedException*/@Before("controllerAspect()")public void doBefore(JoinPoint joinPoint) throws InterruptedException{//線程綁定變量（該數(shù)據(jù)只有當(dāng)前請(qǐng)求的線程可見）Date beginTime = new Date();beginTimeThreadLocal.set(beginTime);}/*** 后置通知(在方法執(zhí)行之后并返回?cái)?shù)據(jù)) 用于攔截Controller層無異常的操作* @param joinPoint 切點(diǎn)*/@AfterReturning("controllerAspect()")public void after(JoinPoint joinPoint){try {String username = "";String description = getControllerMethodInfo(joinPoint).get("description").toString();int type = (int)getControllerMethodInfo(joinPoint).get("type");Map<String, String[]> logParams = request.getParameterMap();EsLog esLog = new EsLog();//請(qǐng)求用戶esLog.setUsername("小偉");//日志標(biāo)題esLog.setName(description);//日志類型esLog.setLogType(type);//日志請(qǐng)求urlesLog.setRequestUrl(request.getRequestURI());//請(qǐng)求方式esLog.setRequestType(request.getMethod());//請(qǐng)求參數(shù)esLog.setMapToParams(logParams);//請(qǐng)求開始時(shí)間long beginTime = beginTimeThreadLocal.get().getTime();long endTime = System.currentTimeMillis();//請(qǐng)求耗時(shí)Long logElapsedTime = endTime - beginTime;esLog.setCostTime(logElapsedTime.intValue());//調(diào)用線程保存至ESThreadPoolUtil.getPool().execute(new SaveEsSystemLogThread(esLog, esLogService));} catch (Exception e) {log.error("AOP后置通知異常", e);}}/*** 保存日志至ES*/private static class SaveEsSystemLogThread implements Runnable {private EsLog esLog;private EsLogService esLogService;public SaveEsSystemLogThread(EsLog esLog, EsLogService esLogService) {this.esLog = esLog;this.esLogService = esLogService;}@Overridepublic void run() {esLogService.saveLog(esLog);}}/*** 獲取注解中對(duì)方法的描述信息用于Controller層注解* @param joinPoint 切點(diǎn)* @return 方法描述* @throws Exception*/public static Map<String, Object> getControllerMethodInfo(JoinPoint joinPoint) throws Exception{Map<String, Object> map = new HashMap<String, Object>(16);//獲取目標(biāo)類名String targetName = joinPoint.getTarget().getClass().getName();//獲取方法名String methodName = joinPoint.getSignature().getName();//獲取相關(guān)參數(shù)Object[] arguments = joinPoint.getArgs();//生成類對(duì)象Class targetClass = Class.forName(targetName);//獲取該類中的方法Method[] methods = targetClass.getMethods();String description = "";Integer type = null;for(Method method : methods) {if(!method.getName().equals(methodName)) {continue;}Class[] clazzs = method.getParameterTypes();if(clazzs.length != arguments.length) {//比較方法中參數(shù)個(gè)數(shù)與從切點(diǎn)中獲取的參數(shù)個(gè)數(shù)是否相同，原因是方法可以重載哦continue;}description = method.getAnnotation(SystemLog.class).description();type = method.getAnnotation(SystemLog.class).type().ordinal();map.put("description", description);map.put("type", type);}return map;}}

7、EsLogService接口類

EsLogService中我們編寫幾個(gè)常用的接口方法，增刪改查：

/*** 日志操作service*/ public interface EsLogService {/*** 添加日志* @param esLog* @return*/EsLog saveLog(EsLog esLog);/*** 通過id刪除日志* @param id*/void deleteLog(String id);/*** 刪除全部日志*/void deleteAll();/*** 分頁搜索獲取日志* @param type* @param key* @param searchVo* @param pageable* @return*/Page<EsLog> findAll(Integer type, String key, SearchVo searchVo, Pageable pageable); }

我們簡(jiǎn)單看一下這個(gè) findAll 方法的實(shí)現(xiàn)類吧，其他方法就是直接調(diào)用ElasticsearchRepository提供的findById()、findAll()、findAllById()、save()等方法。

/*** @param type 類型* @param key 搜索的關(guān)鍵字* @param searchVo* @param pageable* @return*/ @Override public Page<EsLog> findAll(Integer type, String key, SearchVo searchVo, Pageable pageable) {if(type==null&&StrUtil.isBlank(key)&&StrUtil.isBlank(searchVo.getStartDate())){// 無過濾條件獲取全部return logDao.findAll(pageable);}else if(type!=null&&StrUtil.isBlank(key)&&StrUtil.isBlank(searchVo.getStartDate())){// 僅有typereturn logDao.findByLogType(type, pageable);}QueryBuilder qb;QueryBuilder qb0 = QueryBuilders.termQuery("logType", type);QueryBuilder qb1 = QueryBuilders.multiMatchQuery(key, "name", "requestUrl", "requestType","requestParam","username","ip");// 在有type條件下if(StrUtil.isNotBlank(key)&&StrUtil.isBlank(searchVo.getStartDate())&&StrUtil.isBlank(searchVo.getEndDate())){// 僅有keyqb = QueryBuilders.boolQuery().must(qb0).must(qb1);}else if(StrUtil.isBlank(key)&&StrUtil.isNotBlank(searchVo.getStartDate())&&StrUtil.isNotBlank(searchVo.getEndDate())){// 僅有時(shí)間范圍Long start = DateUtil.parse(searchVo.getStartDate()).getTime();Long end = DateUtil.endOfDay(DateUtil.parse(searchVo.getEndDate())).getTime();QueryBuilder qb2 = QueryBuilders.rangeQuery("timeMillis").gte(start).lte(end);qb = QueryBuilders.boolQuery().must(qb0).must(qb2);}else{// 兩者都有Long start = DateUtil.parse(searchVo.getStartDate()).getTime();Long end = DateUtil.endOfDay(DateUtil.parse(searchVo.getEndDate())).getTime();QueryBuilder qb2 = QueryBuilders.rangeQuery("timeMillis").gte(start).lte(end);qb = QueryBuilders.boolQuery().must(qb0).must(qb1).must(qb2);}//多字段搜索return logDao.search(qb, pageable); }

8、controller層測(cè)試方法

/*** 日志操作controller*/ @Slf4j @RestController @RequestMapping("/log") public class LogController {@Autowiredprivate EsLogService esLogService;/*** 測(cè)試*/@SystemLog(description = "測(cè)試", type = LogType.OPERATION)@RequestMapping(value = "/getA", method = RequestMethod.GET)public Result<Object> getA(String va){return ResultUtil.success("測(cè)試成功");}/*** 查詢?nèi)? @param type es 中的logType 不能為空* @param key 查詢的關(guān)鍵字* @param searchVo* @param pageVo* @return*/@RequestMapping(value = "/getAll", method = RequestMethod.GET)public Result<Object> getAll(@RequestParam(required = false) Integer type,@RequestParam String key,SearchVo searchVo,PageVo pageVo){Page<EsLog> es = esLogService.findAll(type, key, searchVo, PageUtil.initPage(pageVo));return ResultUtil.data(es);}/*** 批量刪除* @param ids* @return*/@RequestMapping(value = "/delByIds", method = RequestMethod.POST)public Result<Object> delByIds(@RequestParam String[] ids){for(String id : ids){esLogService.deleteLog(id);}return ResultUtil.success("刪除成功");}/*** 全部刪除* @return*/@RequestMapping(value = "/delAll", method = RequestMethod.POST)public Result<Object> delAll(){esLogService.deleteAll();return ResultUtil.success("刪除成功");} }

以 getA()方法為例，直接通過瀏覽器調(diào)用：http://127.0.0.1:6666/log/getA，然后在 ES 中查詢一下是否保存成功：

以getAll()方法為例，再測(cè)試一下查詢方法，在瀏覽器輸入 http://127.0.0.1:8888/log/getAll?key=&type=2，返回如下：

9、最后補(bǔ)充

本節(jié)是我拆分出來的一個(gè)demo，經(jīng)測(cè)試增刪改查是沒問題、同時(shí)查詢方法加入了分頁查詢，具體代碼細(xì)節(jié)可以下載本節(jié)源碼自行查看。

源碼下載鏈接：https://niceyoo.lanzous.com/id0yikf

如果你覺得本篇文章對(duì)你有所幫助，不如右上角關(guān)注一下我~

18年專科畢業(yè)后，期間一度迷茫，最近我創(chuàng)建了一個(gè)公眾號(hào)用來記錄自己的成長(zhǎng)。

總結(jié)

以上是生活随笔為你收集整理的用Elasticsearch代替数据库存储日志方式的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇： C语言理论作业—2
下一篇： MySQL 常用需求写法记录一下