stu/weblog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

004

Browse Source
This commit is contained in:
wol
2024-12-22 21:00:57 +08:00
parent ff628236d3
commit 88a1d060b0
20 changed files with 649 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
weblog-springboot-004/pom.xml Normal file
View File

@@ -0,0 +1,118 @@
<?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>
<!-- 将 Spring Boot 的版本号切换成 2.6 版本 -->
<version>2.6.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-springboot</artifactId>
<version>${revision}</version>
<name>weblog-springboot</name>
<!-- 项目描述 -->
<description>前后端分离博客 Weblog By 犬小哈</description>
<!-- 多模块项目父工程打包模式必须指定为 pom -->
<packaging>pom</packaging>
<!-- 子模块管理 -->
<modules>
<!-- 入口模块 -->
<module>weblog-web</module>
<!-- 管理后台 -->
<module>weblog-module-admin</module>
<!-- 通用模块 -->
<module>weblog-module-common</module>
</modules>
<!-- 版本号统一管理 -->
<properties>
<!-- 项目版本号 -->
<revision>0.0.1-SNAPSHOT</revision>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- Maven 相关 -->
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<!-- 依赖包版本 -->
<lombok.version>1.18.28</lombok.version>
<guava.version>31.1-jre</guava.version>
<commons-lang3.version>3.12.0</commons-lang3.version>
<jackson.version>2.15.2</jackson.version>
</properties>
<!-- 统一依赖管理 -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-admin</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-common</artifactId>
<version>${revision}</version>
</dependency>
<!-- 常用工具库 -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>${guava.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>${commons-lang3.version}</version>
</dependency>
<!-- Jackson -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<!-- 统一插件管理 -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
<!-- 使用阿里云的 Maven 仓库源，提升包下载速度 -->
<repositories>
<repository>
<id>aliyunmaven</id>
<name>aliyun</name>
<url>https://maven.aliyun.com/repository/public</url>
</repository>
</repositories>
</project>

33
weblog-springboot-004/weblog-module-admin/.gitignore vendored Normal file
View File

@@ -0,0 +1,33 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/

38
weblog-springboot-004/weblog-module-admin/pom.xml Normal file
View File

@@ -0,0 +1,38 @@
<?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>
<!-- 指定父项目为 weblog-springboot -->
<parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-springboot</artifactId>
<version>${revision}</version>
</parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-admin</artifactId>
<name>weblog-module-admin</name>
<description>weblog-admin (负责管理后台相关功能)</description>
<dependencies>
<dependency>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-common</artifactId>
</dependency>
<!-- 免写冗余的 Java 样板式代码 -->
<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>
</dependency>
</dependencies>
</project>

13
weblog-springboot-004/weblog-module-admin/src/test/java/com/quanxiaoha/weblog/admin/WeblogModuleAdminApplicationTests.java Normal file
View File

@@ -0,0 +1,13 @@
package com.quanxiaoha.weblog.admin;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class WeblogModuleAdminApplicationTests {
@Test
void contextLoads() {
}
}

33
weblog-springboot-004/weblog-module-common/.gitignore vendored Normal file
View File

@@ -0,0 +1,33 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/

45
weblog-springboot-004/weblog-module-common/pom.xml Normal file
View File

@@ -0,0 +1,45 @@
<?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>com.quanxiaoha</groupId>
<artifactId>weblog-springboot</artifactId>
<version>${revision}</version>
</parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-common</artifactId>
<name>weblog-module-common</name>
<description>weblog-module-common (此模块用于存放一些通用的功能)</description>
<dependencies>
<!-- 免写冗余的 Java 样板式代码 -->
<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>
</dependency>
<!-- AOP 切面 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- Jackson -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
</dependencies>
</project>

17
weblog-springboot-004/weblog-module-common/src/main/java/com/quanxiaoha/weblog/common/aspect/ApiOperationLog.java Normal file
View File

@@ -0,0 +1,17 @@
package com.quanxiaoha.weblog.common.aspect;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface ApiOperationLog {
/**
* API 功能描述
*
* @return
*/
String description() default "";
}

100
weblog-springboot-004/weblog-module-common/src/main/java/com/quanxiaoha/weblog/common/aspect/ApiOperationLogAspect.java Normal file
View File

@@ -0,0 +1,100 @@
package com.quanxiaoha.weblog.common.aspect;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.function.Function;
import java.util.stream.Collectors;
@Aspect
@Component
@Slf4j
public class ApiOperationLogAspect {
/** 以自定义 @ApiOperationLog 注解为切点，凡是添加 @ApiOperationLog 的方法，都会执行环绕中的代码 */
@Pointcut("@annotation(com.quanxiaoha.weblog.common.aspect.ApiOperationLog)")
public void apiOperationLog() {}
/**
* 环绕
* @param joinPoint
* @return
* @throws Throwable
*/
@Around("apiOperationLog()")
public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
// 请求开始时间
long startTime = System.currentTimeMillis();
// 获取被请求的类和方法
String className = joinPoint.getTarget().getClass().getSimpleName();
String methodName = joinPoint.getSignature().getName();
// 请求入参
Object[] args = joinPoint.getArgs();
String argsJsonStr = Arrays.stream(args).map(toJsonStr()).collect(Collectors.joining(", "));
// 功能描述信息
String description = getApiOperationLogDescription(joinPoint);
// 打印请求相关参数
log.info("====== 请求开始: [{}], 入参: {}, 请求类: {}, 请求方法: {} =================================== ",
description, argsJsonStr, className, methodName);
// 执行切点方法
Object result = joinPoint.proceed();
// 执行耗时
long executionTime = System.currentTimeMillis() - startTime;
// 出参
String resultJsonStr = new ObjectMapper().writeValueAsString(result);
// 打印出参等相关信息
log.info("====== 请求结束: [{}], 耗时: {}ms, 出参: {} =================================== ",
description, executionTime, resultJsonStr);
return result;
}
/**
* 获取注解的描述信息
* @param joinPoint
* @return
*/
private String getApiOperationLogDescription(ProceedingJoinPoint joinPoint) {
// 1. 从 ProceedingJoinPoint 获取 MethodSignature
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 2. 使用 MethodSignature 获取当前被注解的 Method
Method method = signature.getMethod();
// 3. 从 Method 中提取 LogExecution 注解
ApiOperationLog apiOperationLog = method.getAnnotation(ApiOperationLog.class);
// 4. 从 LogExecution 注解中获取 description 属性
return apiOperationLog.description();
}
/**
* 转 JSON 字符串
* @return
*/
private Function<Object, String> toJsonStr() {
return arg -> {
try {
return new ObjectMapper().writeValueAsString(arg);
} catch (JsonProcessingException e) {
return arg.toString();
}
};
}
}

7
weblog-springboot-004/weblog-module-common/src/main/java/com/quanxiaoha/weblog/common/package-info.java Normal file
View File

@@ -0,0 +1,7 @@
/**
* @author: 犬小哈
* @url: www.quanxiaoha.com
* @date: 2023-08-10 9:20
* @description: TODO
**/
package com.quanxiaoha.weblog.common;

13
weblog-springboot-004/weblog-module-common/src/test/java/com/quanxiaoha/weblog/common/WeblogModuleCommonApplicationTests.java Normal file
View File

@@ -0,0 +1,13 @@
package com.quanxiaoha.weblog.common;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class WeblogModuleCommonApplicationTests {
@Test
void contextLoads() {
}
}

33
weblog-springboot-004/weblog-web/.gitignore vendored Normal file
View File

@@ -0,0 +1,33 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/

58
weblog-springboot-004/weblog-web/pom.xml Normal file
View File

@@ -0,0 +1,58 @@
<?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>
<!-- 指定父项目为 weblog-springboot -->
<parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-springboot</artifactId>
<version>${revision}</version>
</parent>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-web</artifactId>
<name>weblog-web</name>
<description>weblog-web (入口项目，负责博客前台展示相关功能，打包也放在这个模块负责)</description>
<dependencies>
<dependency>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-common</artifactId>
</dependency>
<dependency>
<groupId>com.quanxiaoha</groupId>
<artifactId>weblog-module-admin</artifactId>
</dependency>
<!-- Web 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 免写冗余的 Java 样板式代码 -->
<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>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

15
weblog-springboot-004/weblog-web/src/main/java/com/quanxiaoha/weblog/web/WeblogWebApplication.java Normal file
View File

@@ -0,0 +1,15 @@
package com.quanxiaoha.weblog.web;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
@SpringBootApplication
@ComponentScan({"com.quanxiaoha.weblog.*"}) // 多模块项目中，必需手动指定扫描 com.quanxiaoha.weblog 包下面的所有类
public class WeblogWebApplication {
public static void main(String[] args) {
SpringApplication.run(WeblogWebApplication.class, args);
}
}

27
weblog-springboot-004/weblog-web/src/main/java/com/quanxiaoha/weblog/web/controller/TestController.java Normal file
View File

@@ -0,0 +1,27 @@
package com.quanxiaoha.weblog.web.controller;
import com.quanxiaoha.weblog.web.model.User;
import com.quanxiaoha.weblog.common.aspect.ApiOperationLog;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
/**
* @author: 犬小哈
* @url: www.quanxiaoha.com
* @date: 2023-08-10 10:34
* @description: TODO
**/
@RestController
@Slf4j
public class TestController {
@PostMapping("/test")
@ApiOperationLog(description = "测试接口")
public User test(@RequestBody User user) {
// 返参
return user;
}
}

17
weblog-springboot-004/weblog-web/src/main/java/com/quanxiaoha/weblog/web/model/User.java Normal file
View File

@@ -0,0 +1,17 @@
package com.quanxiaoha.weblog.web.model;
import lombok.Data;
/**
* @author: 犬小哈
* @url: www.quanxiaoha.com
* @date: 2023-08-10 10:35
* @description: TODO
**/
@Data
public class User {
// 用户名
private String username;
// 性别
private Integer sex;
}

1
weblog-springboot-004/weblog-web/src/main/resources/application-dev.yml Normal file
View File

@@ -0,0 +1 @@

5
weblog-springboot-004/weblog-web/src/main/resources/application-prod.yml Normal file
View File

@@ -0,0 +1,5 @@
#=================================================================
# log 日志
#=================================================================
logging:
config: classpath:logback-weblog.xml

4
weblog-springboot-004/weblog-web/src/main/resources/application.yml Normal file
View File

@@ -0,0 +1,4 @@
spring:
profiles:
# 默认激活 dev 环境
active: dev

46
weblog-springboot-004/weblog-web/src/main/resources/logback-weblog.xml Normal file
View File

@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration >
<jmxConfigurator/>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<!-- 应用名称 -->
<property scope="context" name="appName" value="weblog" />
<!-- 自定义日志输出路径，以及日志名称前缀 -->
<property name="LOG_FILE" value="/app/weblog/logs/${appName}.%d{yyyy-MM-dd}"/>
<property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
<!--<property name="CONSOLE_LOG_PATTERN" value="${FILE_LOG_PATTERN}"/>-->
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志文件输出的文件名 -->
<FileNamePattern>${LOG_FILE}-%i.log</FileNamePattern>
<!-- 日志文件保留天数 -->
<MaxHistory>30</MaxHistory>
<!-- 日志文件最大的大小 -->
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</TimeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!-- 格式化输出：%d 表示日期，%thread 表示线程名，%-5level：级别从左显示 5 个字符宽度 %errorMessage：日志消息，%n 是换行符-->
<pattern>${FILE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<!-- dev 环境（仅输出到控制台） -->
<springProfile name="dev">
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="info">
<appender-ref ref="CONSOLE" />
</root>
</springProfile>
<!-- prod 环境（仅输出到文件中） -->
<springProfile name="prod">
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="INFO">
<appender-ref ref="FILE" />
</root>
</springProfile>
</configuration>

26
weblog-springboot-004/weblog-web/src/test/java/com/quanxiaoha/weblog/web/WeblogWebApplicationTests.java Normal file
View File

@@ -0,0 +1,26 @@
package com.quanxiaoha.weblog.web;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
class WeblogWebApplicationTests {
@Test
void contextLoads() {
}
@Test
void testLog() {
log.info("这是一行 Info 级别日志");
log.warn("这是一行 Warn 级别日志");
log.error("这是一行 Error 级别日志");
// 占位符
String author = "犬小哈";
log.info("这是一行带有占位符日志，作者：{}", author);
}
}