Merge branch '2.3.x'

Author: hengboy

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/message/pipe/server/MessagePipeServerAutoConfiguration.java

@@ -7,6 +7,8 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.listener.RedisMessageListenerContainer;
 
 import java.util.List;
 import java.util.stream.Collectors;
@@ -16,7 +18,7 @@
  *
  * @author 恒宇少年
  */
-@ConditionalOnClass(ServerConfiguration.class)
+@ConditionalOnClass({ServerConfiguration.class, RedisMessageListenerContainer.class})
 @EnableConfigurationProperties(MessagePipeServerProperties.class)
 public class MessagePipeServerAutoConfiguration {
     private MessagePipeServerProperties messagePipeServerProperties;
@@ -36,6 +38,22 @@ public ServerConfiguration serverConfiguration() {
         return messagePipeServerProperties.getConfiguration();
     }
 
+    /**
+     * Instantiate {@link RedisMessageListenerContainer}
+     * <p>
+     * This instance is required by the message pipeline, but here is just the default configuration
+     *
+     * @param redisConnectionFactory The {@link RedisConnectionFactory} redis connectory factory instance
+     * @return The {@link RedisMessageListenerContainer} instance
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory redisConnectionFactory) {
+        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
+        container.setConnectionFactory(redisConnectionFactory);
+        return container;
+    }
+
     /**
      * Instantiate the wrapper class of {@link MessagePipeConfigurationCustomizer}
      *

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/oauth/ApiBootOauthProperties.java

@@ -27,7 +27,7 @@
 import static org.minbox.framework.api.boot.autoconfigure.oauth.ApiBootOauthProperties.API_BOOT_OAUTH_PREFIX;
 
 /**
- * 整合Oauth2 相关属性配置
+ * Configure Oauth2 properties class
  *
  * @author 恒宇少年
  */
@@ -36,11 +36,13 @@
 @ConfigurationProperties(prefix = API_BOOT_OAUTH_PREFIX)
 public class ApiBootOauthProperties {
     /**
-     * 安全配置前缀
+     * config prefix
      */
     public static final String API_BOOT_OAUTH_PREFIX = "api.boot.oauth";
     /**
-     * Oauth2认证存储方式，默认内存方式
+     * Configure oauth authentication information storage mode
+     * <p>
+     * The default use {@link OAuthAway#memory}
      *
      * @see OAuthAway
      */
@@ -59,89 +61,36 @@ public class ApiBootOauthProperties {
     @Deprecated
     private String clientSecret = "ApiBootSecret";
     /**
-     * 客户端授权类型集合
+     * Configure simple client grant types
      * 2.1.1. After the RELEASE version, the attribute is discarded and replaced by clients.
      */
     @Deprecated
     private String[] grantTypes = new String[]{"password", "refresh_token"};
     /**
-     * 客户端作用域集合
+     * Configure simple client scopes
      * 2.1.1. After the RELEASE version, the attribute is discarded and replaced by clients.
      */
     @Deprecated
     private String[] scopes = new String[]{"api"};
     /**
-     * 资源编号
+     * Configure simple client resource id
      * 2.1.1. After the RELEASE version, the attribute is discarded and replaced by clients.
      */
     @Deprecated
     private String resourceId = "api";
 
     /**
-     * 配置JWT格式化Oauth2返回的token
+     * Configure to use jwt to format oauth token
      */
     private Jwt jwt = new Jwt();
     /**
      * configure multiple clients
+     * <p>
+     * Add a client information by default and use the default configuration
      */
-    private List<Client> clients = new ArrayList() {{
-        add(new Client());
-    }};
-
-    /**
-     * Oauth2 Client
-     * Used to configure multiple clients
-     */
-    @Data
-    public static class Client {
-        /**
-         * oauth2 client id
-         */
-        private String clientId = "ApiBoot";
-        /**
-         * oauth2 client secret
-         */
-        private String clientSecret = "ApiBootSecret";
-        /**
-         * oauth2 client grant types
-         * default value is "password,refresh_token"
-         */
-        private String[] grantTypes = new String[]{"password", "refresh_token"};
-        /**
-         * oauth2 client scope
-         * default value is "api"
-         */
-        private String[] scopes = new String[]{"api"};
-        /**
-         * oauth2 application resource id
-         * default value is "api"
-         */
-        private String[] resourceId = new String[]{"api"};
-        /**
-         * oauth2 access token validity seconds
-         * default value is 2 hours (7200 second)
-         */
-        private int accessTokenValiditySeconds = 60 * 60 * 2;
-        /**
-         * oauth2 refresh token validity seconds
-         * <p>
-         * The default value is 30 days（2592000 seconds）
-         */
-        private int refreshTokenValiditySeconds = 60 * 60 * 24 * 30;
-    }
-
-    /**
-     * 自定义Jwt相关的配置
-     */
-    @Data
-    public static class Jwt {
-        /**
-         * 开启Jwt转换AccessToken
-         */
-        private boolean enable = false;
-        /**
-         * Jwt转换时使用的秘钥key
-         */
-        private String signKey = "ApiBoot";
-    }
+    private List<OAuthClient> clients = new ArrayList() {
+        {
+            add(new OAuthClient());
+        }
+    };
 }

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/oauth/Jwt.java

@@ -0,0 +1,20 @@
+package org.minbox.framework.api.boot.autoconfigure.oauth;
+
+import lombok.Data;
+
+/**
+ * The json web token config properties
+ *
+ * @author 恒宇少年
+ */
+@Data
+public class Jwt {
+    /**
+     * Enable the use of jwt formatting token
+     */
+    private boolean enable = false;
+    /**
+     * The secret key used during conversion
+     */
+    private String signKey = "ApiBoot";
+}

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/oauth/OAuthClient.java

@@ -0,0 +1,46 @@
+package org.minbox.framework.api.boot.autoconfigure.oauth;
+
+import lombok.Data;
+
+/**
+ * oauth client configuration class
+ *
+ * @author 恒宇少年
+ */
+@Data
+public class OAuthClient {
+    /**
+     * oauth2 client id
+     */
+    private String clientId = "ApiBoot";
+    /**
+     * oauth2 client secret
+     */
+    private String clientSecret = "ApiBootSecret";
+    /**
+     * oauth2 client grant types
+     * default value is "password,refresh_token"
+     */
+    private String[] grantTypes = new String[]{"password", "refresh_token"};
+    /**
+     * oauth2 client scope
+     * default value is "api"
+     */
+    private String[] scopes = new String[]{"api"};
+    /**
+     * oauth2 application resource id
+     * default value is "api"
+     */
+    private String[] resourceId = new String[]{"api"};
+    /**
+     * oauth2 access token validity seconds
+     * default value is 2 hours (7200 second)
+     */
+    private int accessTokenValiditySeconds = 60 * 60 * 2;
+    /**
+     * oauth2 refresh token validity seconds
+     * <p>
+     * The default value is 30 days（2592000 seconds）
+     */
+    private int refreshTokenValiditySeconds = 60 * 60 * 24 * 30;
+}

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/pageable/ApiBootMyBatisPageableProperties.java

@@ -22,21 +22,15 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
 
-import java.lang.reflect.Field;
 import java.util.Properties;
 
 import static org.minbox.framework.api.boot.autoconfigure.pageable.ApiBootMyBatisPageableProperties.API_BOOT_PAGEABLE_PREFIX;
 
 
 /**
- * mybatis-pageable自动化配置属性
+ * Mybatis pageable properties
  *
- * @author：于起宇 ===============================
- * Created with IDEA.
- * Date：2018/8/4
- * Time：2:22 PM
- * 简书：http://www.jianshu.com/u/092df3f77bca
- * ================================
+ * @author 恒宇少年
  */
 @Data
 @Configuration
@@ -47,39 +41,20 @@ public class ApiBootMyBatisPageableProperties {
      */
     public static final String API_BOOT_PAGEABLE_PREFIX = "api.boot.pageable";
     /**
-     * 数据库方言
-     * 默认使用mysql数据库方言
+     * The database dialect
+     * <p>
+     * default use {@link DialectEnum#MYSQL}
      */
     private DialectEnum dialect = DialectEnum.MYSQL;
 
     /**
-     * 获取属性配置
+     * Convert this instance to {@link Properties}
      *
-     * @return 配置文件对象
+     * @return The {@link Properties} config instance
      */
-    public Properties getProperties() {
-
-        // 返回的配置对象
+    public Properties convertProperties() {
         Properties properties = new Properties();
-        /*
-         * 获取本类内创建的field列表
-         * 添加到配置对象集合内
-         */
-        Field[] fields = this.getClass().getDeclaredFields();
-        for (Field field : fields) {
-            try {
-                field.setAccessible(true);
-                // 数据库方言
-                if ("dialect".equals(field.getName())) {
-                    properties.setProperty(field.getName(), dialect.getValue().getName());
-                } else {
-                    properties.setProperty(field.getName(), String.valueOf(field.get(this)));
-                }
-            } catch (Exception e) {
-                e.printStackTrace();
-            }
-        }
-
+        properties.setProperty(PropertiesNames.DATABASE_DIALECT, dialect.getValue().getName());
         return properties;
     }
 }

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/pageable/ApiBootMybatisPageableAutoConfiguration.java

@@ -31,17 +31,12 @@
 
 import javax.annotation.PostConstruct;
 import java.util.List;
+import java.util.Properties;
 
 /**
  * ApiBoot Mybatis Pageable Auto Configuration
  *
- * @author：恒宇少年 - 于起宇
- * <p>
- * DateTime：2019-04-25 14:53
- * Blog：http://blog.yuqiyu.com
- * WebSite：http://www.jianshu.com/u/092df3f77bca
- * Gitee：https://gitee.com/hengboy
- * GitHub：https://github.com/hengboy
+ * @author 恒宇少年
  */
 @Configuration
 @ConditionalOnBean(SqlSessionFactory.class)
@@ -50,9 +45,9 @@
 @AutoConfigureAfter(DataSourceAutoConfiguration.class)
 public class ApiBootMybatisPageableAutoConfiguration {
     /**
-     * myabtis pageable properties
+     * mybatis pageable properties
      */
-    private ApiBootMyBatisPageableProperties myBatisPageableProperties;
+    private ApiBootMyBatisPageableProperties pageableProperties;
     /**
      * mybatis sqlSession factory
      */
@@ -65,7 +60,7 @@ public class ApiBootMybatisPageableAutoConfiguration {
     public ApiBootMybatisPageableAutoConfiguration(ApiBootMyBatisPageableProperties myBatisPageableProperties,
                                                    ObjectProvider<List<SqlSessionFactory>> interceptorsProvider,
                                                    ObjectProvider<PageableConfigurer> pageableConfigurerObjectProvider) {
-        this.myBatisPageableProperties = myBatisPageableProperties;
+        this.pageableProperties = myBatisPageableProperties;
         this.sqlSessionFactoryList = interceptorsProvider.getIfAvailable();
         this.pageableConfigurer = pageableConfigurerObjectProvider.getIfAvailable();
     }
@@ -77,7 +72,8 @@ public ApiBootMybatisPageableAutoConfiguration(ApiBootMyBatisPageableProperties
     void addInterceptors() {
         Interceptor interceptor = new MyBatisExecutePageableInterceptor();
         // set properties to interceptor
-        interceptor.setProperties(myBatisPageableProperties.getProperties());
+        Properties properties = pageableProperties.convertProperties();
+        interceptor.setProperties(properties);
 
         for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
             // pre
@@ -90,9 +86,9 @@ void addInterceptors() {
     }
 
     /**
-     * pre interceptors
+     * add pre interceptors
      *
-     * @param sqlSessionFactory sqlSessionFactory对象实例
+     * @param sqlSessionFactory The {@link SqlSessionFactory} instance
      */
     void addPreInterceptors(SqlSessionFactory sqlSessionFactory) {
         if (allowPageableConfigurer() && pageableConfigurer.prePlugins() != null) {
@@ -101,9 +97,9 @@ void addPreInterceptors(SqlSessionFactory sqlSessionFactory) {
     }
 
     /**
-     * after interceptors
+     * add after interceptors
      *
-     * @param sqlSessionFactory sqlSessionFactory对象实例
+     * @param sqlSessionFactory The {@link SqlSessionFactory} instance
      */
     void addPostInterceptors(SqlSessionFactory sqlSessionFactory) {
         if (allowPageableConfigurer() && pageableConfigurer.postPlugins() != null) {

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/pageable/PropertiesNames.java

@@ -0,0 +1,13 @@
+package org.minbox.framework.api.boot.autoconfigure.pageable;
+
+/**
+ * The MyBatis pageable config properties names
+ *
+ * @author 恒宇少年
+ */
+public interface PropertiesNames {
+    /**
+     * The name of database dialect properties
+     */
+    String DATABASE_DIALECT = "dialect";
+}