docs: readme

feat: 配置类调整
fuhouyu · Nov 1, 2024 · b68471e · b68471e
1 parent ee91dfe
commit b68471e
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -3,20 +3,28 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fuhouyu_base-framework&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fuhouyu_base-framework)
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=fuhouyu_base-framework&metric=bugs&branch=develop)](https://sonarcloud.io/summary/new_code?id=fuhouyu_base-framework&branch=develop)
 [![codecov](https://codecov.io/github/fuhouyu/base-framework/graph/badge.svg?token=VUT9BFMLK9)](https://codecov.io/github/fuhouyu/base-framework)
+
 [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
--------
+----
+
+-----
 
 ### 简介
 
-| 模块名                          |                 描述                  |
-| :-----------------------------: | :-----------------------------------: |
-| base-framework-cache-starter    |    缓存抽象，Reids、Caffeine的实现    |
-| base-framework-common           |        公共组件，常用工具类等         |
-| base-framework-context          |    上下文组件，目前只仅用户上下文     |
-| base-framework-dependencies     |         内部模块组件版本定义          |
-| Base-framework-log-starter      |    日志组件，logback和业务日志切面    |
-| base-framework-resource-starter |               资源组件                |
-| base-framework-security-starter |  安全认证组件，用户认证，token存储等  |
-| base-framework-web-starter              | web相关组件，常用拦截器，用户信息解析 |
-| base-framework-kms-starter              | 对称非对称加解密组件 |
+|                                模块名                                 |            描述             |
+|:------------------------------------------------------------------:|:-------------------------:|
+|    [base-framework-cache-starter](base-framework-cache-starter)    | 缓存Starter，caffine及redis实现 |
+|           [base-framework-common](base-framework-common)           |        公共组件，常用工具类         |
+|          [base-framework-context](base-framework-context)          |       上下文组件，用户、请求定义       |
+|     [base-framework-dependencies](base-framework-dependencies)     |          内部模块组件           |
+|      [base-framework-log-starter](base-framework-log-starter)      |    日志组件，logback和业务日志切面    |
+| [base-framework-resource-starter](base-framework-resource-starter) |       资源组件，本地、阿里云实现       |
+| [base-framework-security-starter](base-framework-security-starter) |     安全认证组件，security封装     |
+|      [base-framework-web-starter](base-framework-web-starter)      |        web组件，常用拦截器        |
+|      [base-framework-kms-starter](base-framework-kms-starter)      |        对称非对称加解密组件         |
+
+----
+
+
+
 
diff --git a/...ework-cache-starter/src/main/java/com/fuhouyu/framework/cache/CacheAutoConfiguration.java b/...ework-cache-starter/src/main/java/com/fuhouyu/framework/cache/CacheAutoConfiguration.java
@@ -30,7 +30,7 @@
  * @since 2024/8/13 21:00
  */
 @Configuration
-@Import({RedisCacheAutoConfiguration.class, CaffeineCacheAutoconfiguration.class})
+@Import({RedisCacheConfiguration.class, CaffeineCacheConfiguration.class})
 @EnableConfigurationProperties(CacheProperties.class)
 public class CacheAutoConfiguration {
 

diff --git a/...cache/CaffeineCacheAutoconfiguration.java → ...ork/cache/CaffeineCacheConfiguration.java b/...cache/CaffeineCacheAutoconfiguration.java → ...ork/cache/CaffeineCacheConfiguration.java
@@ -40,7 +40,7 @@
 @ConditionalOnProperty(prefix = CacheServiceProperties.PREFIX,
         name = "cache-service-type",
         havingValue = "caffeine")
-public class CaffeineCacheAutoconfiguration {
+public class CaffeineCacheConfiguration {
 
     @Bean
     @Primary

diff --git a/...rk/cache/RedisCacheAutoConfiguration.java → ...mework/cache/RedisCacheConfiguration.java b/...rk/cache/RedisCacheAutoConfiguration.java → ...mework/cache/RedisCacheConfiguration.java
@@ -49,7 +49,7 @@
         havingValue = "redis")
 @AutoConfigureAfter(RedisAutoConfiguration.class)
 @Configuration
-public class RedisCacheAutoConfiguration {
+public class RedisCacheConfiguration {
 
 
     @Bean

diff --git a/...work/kms/DefaultKmsAutoConfiguration.java → ...ramework/kms/DefaultKmsConfiguration.java b/...work/kms/DefaultKmsAutoConfiguration.java → ...ramework/kms/DefaultKmsConfiguration.java
@@ -60,7 +60,7 @@
 @EnableConfigurationProperties(KmsDefaultProperties.class)
 @RequiredArgsConstructor
 @Configuration
-public class DefaultKmsAutoConfiguration {
+public class DefaultKmsConfiguration {
 
     private final KmsDefaultProperties properties;
 

diff --git a/base-framework-kms-starter/src/main/java/com/fuhouyu/framework/kms/KmsAutoConfiguration.java b/base-framework-kms-starter/src/main/java/com/fuhouyu/framework/kms/KmsAutoConfiguration.java
@@ -27,7 +27,7 @@
  * @author fuhouyu
  * @since 2024/8/17 17:27
  */
-@Import({DefaultKmsAutoConfiguration.class})
+@Import({DefaultKmsConfiguration.class})
 @Configuration
 public class KmsAutoConfiguration {
 

diff --git a/...curity/OpenPlatformAutoConfiguration.java → ...k/security/OpenPlatformConfiguration.java b/...curity/OpenPlatformAutoConfiguration.java → ...k/security/OpenPlatformConfiguration.java
@@ -30,7 +30,7 @@
  */
 @Configuration
 @EnableConfigurationProperties(OpenPlatformAuthProperties.class)
-public class OpenPlatformAutoConfiguration {
+public class OpenPlatformConfiguration {
 
 
 }
diff --git a/...urity-starter/src/main/java/com/fuhouyu/framework/security/SecurityAutoConfiguration.java b/...urity-starter/src/main/java/com/fuhouyu/framework/security/SecurityAutoConfiguration.java
@@ -45,7 +45,7 @@
  * @since 2024/8/15 16:22
  */
 @Configuration
-@Import({OpenPlatformAutoConfiguration.class})
+@Import({OpenPlatformConfiguration.class})
 @AutoConfigureAfter(CacheAutoConfiguration.class)
 public class SecurityAutoConfiguration {
 

diff --git a/...ework-security-starter/src/test/java/com/fuhouyu/framework/security/RefreshTokenTest.java b/...ework-security-starter/src/test/java/com/fuhouyu/framework/security/RefreshTokenTest.java
@@ -16,7 +16,7 @@
 package com.fuhouyu.framework.security;
 
 import com.fuhouyu.framework.cache.CacheAutoConfiguration;
-import com.fuhouyu.framework.cache.CaffeineCacheAutoconfiguration;
+import com.fuhouyu.framework.cache.CaffeineCacheConfiguration;
 import com.fuhouyu.framework.security.core.GrantTypeAuthenticationTokenEnum;
 import com.fuhouyu.framework.security.entity.TokenEntity;
 import com.fuhouyu.framework.security.token.TokenStore;
@@ -43,7 +43,7 @@
  */
 @SpringBootTest(classes = {
         CacheAutoConfiguration.class,
-        CaffeineCacheAutoconfiguration.class,
+        CaffeineCacheConfiguration.class,
         SecurityAutoConfiguration.class,
         BaseComponent.class
 })

diff --git a/...security-starter/src/test/java/com/fuhouyu/framework/security/Sm3PasswordEncoderTest.java b/...security-starter/src/test/java/com/fuhouyu/framework/security/Sm3PasswordEncoderTest.java
@@ -17,7 +17,7 @@
 package com.fuhouyu.framework.security;
 
 import com.fuhouyu.framework.cache.CacheAutoConfiguration;
-import com.fuhouyu.framework.cache.CaffeineCacheAutoconfiguration;
+import com.fuhouyu.framework.cache.CaffeineCacheConfiguration;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,7 +35,7 @@
  */
 @SpringBootTest(classes = {
         CacheAutoConfiguration.class,
-        CaffeineCacheAutoconfiguration.class,
+        CaffeineCacheConfiguration.class,
         SecurityAutoConfiguration.class,
         BaseComponent.class
 })

diff --git a/...amework-security-starter/src/test/java/com/fuhouyu/framework/security/TokenStoreTest.java b/...amework-security-starter/src/test/java/com/fuhouyu/framework/security/TokenStoreTest.java
@@ -17,7 +17,7 @@
 package com.fuhouyu.framework.security;
 
 import com.fuhouyu.framework.cache.CacheAutoConfiguration;
-import com.fuhouyu.framework.cache.CaffeineCacheAutoconfiguration;
+import com.fuhouyu.framework.cache.CaffeineCacheConfiguration;
 import com.fuhouyu.framework.cache.service.CacheService;
 import com.fuhouyu.framework.security.entity.TokenEntity;
 import com.fuhouyu.framework.security.token.TokenStore;
@@ -44,7 +44,7 @@
  */
 @SpringBootTest(classes = {
         CacheAutoConfiguration.class,
-        CaffeineCacheAutoconfiguration.class,
+        CaffeineCacheConfiguration.class,
         SecurityAutoConfiguration.class,
         BaseComponent.class
 })

diff --git a/.../framework/web/FormAutoConfiguration.java → ...ouyu/framework/web/FormConfiguration.java b/.../framework/web/FormAutoConfiguration.java → ...ouyu/framework/web/FormConfiguration.java
@@ -30,7 +30,7 @@
  * @since 2024/8/17 23:07
  */
 @RequiredArgsConstructor
-public class FormAutoConfiguration {
+public class FormConfiguration {
 
     private final CacheService<String, Object> cacheService;
 

diff --git a/base-framework-web-starter/src/main/java/com/fuhouyu/framework/web/WebAutoConfiguration.java b/base-framework-web-starter/src/main/java/com/fuhouyu/framework/web/WebAutoConfiguration.java
@@ -42,7 +42,7 @@
  * @author fuhouyu
  * @since 2024/8/15 20:18
  */
-@Import({WebMvcAutoConfiguration.class, FormAutoConfiguration.class})
+@Import({WebMvcConfiguration.class, FormConfiguration.class})
 @ComponentScan(basePackageClasses = WebAutoConfiguration.class)
 @ConfigurationPropertiesScan(basePackages = "com.fuhouyu.framework.web.properties")
 public class WebAutoConfiguration {