From c058f13cb8a8590ee7fe1ed9a4aa87acada37aa7 Mon Sep 17 00:00:00 2001 From: "yong.teng" Date: Wed, 29 Nov 2023 12:49:22 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/manual/0.0/cache/index.md | 23 ----- src/manual/0.0/captcha/index.md | 23 ----- src/manual/0.0/cli/index.md | 48 ---------- .../ConfigurationProperties.md | 0 src/manual/0.0/client/index.md | 23 +++++ .../ConfigurationProperties.md | 0 src/manual/0.0/core/index.md | 23 +++++ .../0.0/datasource/ConfigurationProperties.md | 49 ---------- src/manual/0.0/datasource/index.md | 21 ----- .../0.0/geoip/ConfigurationProperties.md | 12 --- src/manual/0.0/geoip/index.md | 23 ----- .../0.0/httpclient/ConfigurationProperties.md | 11 --- src/manual/0.0/httpclient/index.md | 24 ----- src/manual/0.0/index.md | 24 ++--- .../0.0/mongodb/ConfigurationProperties.md | 12 --- src/manual/0.0/mongodb/index.md | 24 ----- .../0.0/mybatis/ConfigurationProperties.md | 23 ----- src/manual/0.0/mybatis/index.md | 24 ----- .../0.0/pac4j/ConfigurationProperties.md | 71 -------------- src/manual/0.0/pac4j/index.md | 24 ----- .../0.0/session/ConfigurationProperties.md | 7 -- src/manual/0.0/session/index.md | 24 ----- .../0.0/shiro/ConfigurationProperties.md | 41 -------- src/manual/0.0/shiro/index.md | 24 ----- .../ConfigurationProperties.md | 0 src/manual/0.0/spring/index.md | 23 +++++ .../0.0/velocity/ConfigurationProperties.md | 23 ----- src/manual/0.0/velocity/index.md | 24 ----- src/manual/0.0/web/ConfigurationProperties.md | 65 ------------- src/manual/0.0/web/index.md | 23 ----- src/manual/0.0/web/startup.md | 94 ------------------- src/manual/SUMMARY.md | 2 +- 32 files changed, 77 insertions(+), 755 deletions(-) delete mode 100644 src/manual/0.0/cache/index.md delete mode 100644 src/manual/0.0/captcha/index.md delete mode 100644 src/manual/0.0/cli/index.md rename src/manual/0.0/{captcha => client}/ConfigurationProperties.md (100%) create mode 100644 src/manual/0.0/client/index.md rename src/manual/0.0/{cache => core}/ConfigurationProperties.md (100%) create mode 100644 src/manual/0.0/core/index.md delete mode 100644 src/manual/0.0/datasource/ConfigurationProperties.md delete mode 100644 src/manual/0.0/datasource/index.md delete mode 100644 src/manual/0.0/geoip/ConfigurationProperties.md delete mode 100644 src/manual/0.0/geoip/index.md delete mode 100644 src/manual/0.0/httpclient/ConfigurationProperties.md delete mode 100644 src/manual/0.0/httpclient/index.md delete mode 100644 src/manual/0.0/mongodb/ConfigurationProperties.md delete mode 100644 src/manual/0.0/mongodb/index.md delete mode 100644 src/manual/0.0/mybatis/ConfigurationProperties.md delete mode 100644 src/manual/0.0/mybatis/index.md delete mode 100644 src/manual/0.0/pac4j/ConfigurationProperties.md delete mode 100644 src/manual/0.0/pac4j/index.md delete mode 100644 src/manual/0.0/session/ConfigurationProperties.md delete mode 100644 src/manual/0.0/session/index.md delete mode 100644 src/manual/0.0/shiro/ConfigurationProperties.md delete mode 100644 src/manual/0.0/shiro/index.md rename src/manual/0.0/{cli => spring}/ConfigurationProperties.md (100%) create mode 100644 src/manual/0.0/spring/index.md delete mode 100644 src/manual/0.0/velocity/ConfigurationProperties.md delete mode 100644 src/manual/0.0/velocity/index.md delete mode 100644 src/manual/0.0/web/ConfigurationProperties.md delete mode 100644 src/manual/0.0/web/index.md delete mode 100644 src/manual/0.0/web/startup.md diff --git a/src/manual/0.0/cache/index.md b/src/manual/0.0/cache/index.md deleted file mode 100644 index f4715ed..0000000 --- a/src/manual/0.0/cache/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-cache 参考手册 - - -buession-redis 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-cache - x.x.x - -``` - -该模块实现了[buession-redis](https://www.buession.com/manual/2.3/redis/index.html) 中 `RedisTemplate` 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-cache/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/captcha/index.md b/src/manual/0.0/captcha/index.md deleted file mode 100644 index 6c9c598..0000000 --- a/src/manual/0.0/captcha/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-captcha 参考手册 - - -buession-security-captcha 行为验证码自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-captcha - x.x.x - -``` - -该模块实现了[buession-security-captcha](https://security.buession.com/manual/2.3/captcha/index.html) 行为阿里云、极验、腾讯云等行为验证客户端 `CaptchaClient` 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-captcha/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/cli/index.md b/src/manual/0.0/cli/index.md deleted file mode 100644 index bb66edd..0000000 --- a/src/manual/0.0/cli/index.md +++ /dev/null @@ -1,48 +0,0 @@ -# buession-springboot-cli 参考手册 - - -SpringBoot 命令行应用。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-cli - x.x.x - -``` - -该模块定义了命令模式下的 SpringBootApplication 抽象类。通过该类，简化了您在编写命令行模式下的 SpringBoot 应用代码。 - -```java -import com.buession.springboot.cli.application.AbstractCliApplication; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.context.annotation.EnableAspectJAutoProxy; - -@SpringBootApplication(scanBasePackages = {"com.buession.springboot.demo"}) -@EnableAutoConfiguration(exclude = {}) -@EnableAspectJAutoProxy(proxyTargetClass = true) -public class DemoCliApplication extends AbstractCliApplication { - - protected DemoCliApplication(){ - - } - - public final static void main(final String[] args){ - DemoCliApplication application = new DemoCliApplication(); - application.startup(args); - } - -} -``` - -他强制将 webApplicationType 设置成：`WebApplicationType.NONE`。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-cli/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/captcha/ConfigurationProperties.md b/src/manual/0.0/client/ConfigurationProperties.md similarity index 100% rename from src/manual/0.0/captcha/ConfigurationProperties.md rename to src/manual/0.0/client/ConfigurationProperties.md diff --git a/src/manual/0.0/client/index.md b/src/manual/0.0/client/index.md new file mode 100644 index 0000000..241fbcf --- /dev/null +++ b/src/manual/0.0/client/index.md @@ -0,0 +1,23 @@ +# buession-canal-client 参考手册 + + +buession canal 客户端。 + + +--- + + +### 安装 + +```xml + + com.buession.canal + buession-canal-client + x.x.x + +``` + +该模块主要实现了 tcp、kafka、RabbitMQ、Pulsar、RocketMQ 适配器客户端，以及 buession canal 客户端 API。 + + +### [API 参考手册>>](https://javadoc.io/static/com.buession.canal/buession-canal-client/0.0.1/) \ No newline at end of file diff --git a/src/manual/0.0/cache/ConfigurationProperties.md b/src/manual/0.0/core/ConfigurationProperties.md similarity index 100% rename from src/manual/0.0/cache/ConfigurationProperties.md rename to src/manual/0.0/core/ConfigurationProperties.md diff --git a/src/manual/0.0/core/index.md b/src/manual/0.0/core/index.md new file mode 100644 index 0000000..b2d187a --- /dev/null +++ b/src/manual/0.0/core/index.md @@ -0,0 +1,23 @@ +# buession-canal-core 参考手册 + + +buession canal 核心类库。 + + +--- + + +### 安装 + +```xml + + com.buession.canal + buession-canal-core + x.x.x + +``` + +该模块定义了 buession canal 核心 API。 + + +### [API 参考手册>>](https://javadoc.io/static/com.buession.canal/buession-canal-core/0.0.1/) \ No newline at end of file diff --git a/src/manual/0.0/datasource/ConfigurationProperties.md b/src/manual/0.0/datasource/ConfigurationProperties.md deleted file mode 100644 index 432f8cf..0000000 --- a/src/manual/0.0/datasource/ConfigurationProperties.md +++ /dev/null @@ -1,49 +0,0 @@ -# buession-springboot-datasource 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.datasource.type | Class | -- | DataSource 类型 | -| spring.datasource.driver-class-name | String | -- | 数据库驱动类名 | -| spring.datasource.master | org.springframework.boot.autoconfigure.jdbc.DataSourceProperties | -- | Master 数据源配置 | -| spring.datasource.slaves | List | -- | Slave 数据源配置列表 | - - -#### Hikari 数据源连接池 - -配置属性前缀：spring.datasource.hikari - -详细配置参见：[https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/HikariPoolConfiguration.html](https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/HikariPoolConfiguration.html) - - -#### DHCP2 数据源连接池 - -配置属性前缀：spring.datasource.dbcp2 - -详细配置参见：[https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/Dbcp2PoolConfiguration.html](https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/Dbcp2PoolConfiguration.html) - - -#### Druid 数据源连接池 - -配置属性前缀：spring.datasource.druid - -详细配置参见：[https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/DruidPoolConfiguration.html](https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/DruidPoolConfiguration.html) - - -#### Tomcat 数据源连接池 - -配置属性前缀：spring.datasource.tomcat - -详细配置参见：[https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/TomcatPoolConfiguration.html](https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/TomcatPoolConfiguration.html) - - -#### 一般的数据源连接池 - -配置属性前缀：spring.datasource.generic - -详细配置参见：[https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/GenericPoolConfiguration.html](https://javadoc.io/static/com.buession/buession-jdbc/2.3.0/com/buession/jdbc/datasource/config/GenericPoolConfiguration.html) \ No newline at end of file diff --git a/src/manual/0.0/datasource/index.md b/src/manual/0.0/datasource/index.md deleted file mode 100644 index 16b9cf1..0000000 --- a/src/manual/0.0/datasource/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# buession-springboot-datasource 参考手册 - - -jdbc datasource 自动配置类，支持读写分离，spring transaction manager 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-datasource - x.x.x - -``` - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-datasource/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/geoip/ConfigurationProperties.md b/src/manual/0.0/geoip/ConfigurationProperties.md deleted file mode 100644 index dd88499..0000000 --- a/src/manual/0.0/geoip/ConfigurationProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -# buession-springboot-geoip 参考手册 - - -## 配置属性 - - -#### 通用 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.geoip.db-path | String | -- | IP 库文件路径 | -| spring.geoip.enable-cache | boolean | true | 是否开启缓存 | \ No newline at end of file diff --git a/src/manual/0.0/geoip/index.md b/src/manual/0.0/geoip/index.md deleted file mode 100644 index 1c23a81..0000000 --- a/src/manual/0.0/geoip/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-boot 参考手册 - - -buession-geoip 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-geoip - x.x.x - -``` - -该模块实现了[buession-geoip](https://www.buession.com/manual/2.3/geoip/index.html) 中 `Resolver` 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-geoip/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/httpclient/ConfigurationProperties.md b/src/manual/0.0/httpclient/ConfigurationProperties.md deleted file mode 100644 index f0f827a..0000000 --- a/src/manual/0.0/httpclient/ConfigurationProperties.md +++ /dev/null @@ -1,11 +0,0 @@ -# buession-springboot-httpclient 参考手册 - - -## 配置属性 - - -#### 通用配置 - -配置属性前缀：spring.httpclient - -详细配置参见：[https://javadoc.io/static/com.buession/buession-httpclient/2.3.0/com/buession/httpclient/core/Configuration.html](https://javadoc.io/static/com.buession/buession-httpclient/2.3.0/com/buession/httpclient/core/Configuration.html) \ No newline at end of file diff --git a/src/manual/0.0/httpclient/index.md b/src/manual/0.0/httpclient/index.md deleted file mode 100644 index 6e24368..0000000 --- a/src/manual/0.0/httpclient/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-httpclient 参考手册 - - -buession-httpclient 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-httpclient - x.x.x - -``` - - -该模块实现了[buession-httpclient](https://www.buession.com/manual/2.3/httpclient/index.html) 中 HTTP 客户端 `ApacheHttpClient` 或 `OkHttpHttpClient` 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-httpclient/2.3.0/)å \ No newline at end of file diff --git a/src/manual/0.0/index.md b/src/manual/0.0/index.md index 23aac09..67c4c4f 100644 --- a/src/manual/0.0/index.md +++ b/src/manual/0.0/index.md @@ -1,22 +1,12 @@ # API 参考手册 -Buession SpringBoot API 包含以下目录： +Buession Canal API 包含以下目录： -| 模块 | 使用帮助 | 手册 | -| ---- | ---- | ---- | -| buession-springboot-boot | [使用帮助](boot/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-boot/2.3.0/) | -| buession-springboot-cache | [使用帮助](cache/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-cache/2.3.0/) | -| buession-springboot-captcha | [使用帮助](captcha/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-captcha/2.3.0/) | -| buession-springboot-cli | [使用帮助](cli/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-cli/2.3.0/) | -| buession-springboot-datasource | [使用帮助](datasource/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-datasource/2.3.0/) | -| buession-springboot-geoip | [使用帮助](geoip/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-geoip/2.3.0/) | -| buession-springboot-httpclient | [使用帮助](httpclient/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-httpclient/2.3.0/) | -| buession-springboot-mongodb | [使用帮助](mongodb/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-mongodb/2.3.0/) | -| buession-springboot-mybatis | [使用帮助](mybatis/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-mybatis/2.3.0/) | -| buession-springboot-pac4j | [使用帮助](pac4j/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/) | -| buession-springboot-session | [使用帮助](session/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-session/2.3.0/) | -| buession-springboot-shiro | [使用帮助](shiro/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-shiro/2.3.0/) | -| buession-springboot-velocity | [使用帮助](velocity/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/buession-springboot-velocity/2.3.0/) | -| buession-springboot-web | [使用帮助](web/index.md) | [API 手册](https://javadoc.io/static/com.buession.springboot/uession-springboot-web/2.3.0/) | \ No newline at end of file +| 模块 | 使用帮助 | 手册 | +| ---- | ---- | ---- | +| com-canal-annotation | [使用帮助](annotation/index.md) | [API 手册](https://javadoc.io/static/com.buession.canal/com-canal-annotation/0.0.1/) | +| com-canal-core | [使用帮助](core/index.md) | [API 手册](https://javadoc.io/static/com.buession.canal/com-canal-core/0.0.1/) | +| com-canal-client | [使用帮助](client/index.md) | [API 手册](https://javadoc.io/static/com.buession.canal/com-canal-client/0.0.1/) | +| com-canal-spring | [使用帮助](spring/index.md) | [API 手册](https://javadoc.io/static/com.buession.canal/com-canal-spring/0.0.1/) | \ No newline at end of file diff --git a/src/manual/0.0/mongodb/ConfigurationProperties.md b/src/manual/0.0/mongodb/ConfigurationProperties.md deleted file mode 100644 index 26e441f..0000000 --- a/src/manual/0.0/mongodb/ConfigurationProperties.md +++ /dev/null @@ -1,12 +0,0 @@ -# buession-springboot-mongodb 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.mongodb.type-mapper | Class | -- | MongoTypeMapper，优先级高于默认的 MongoTypeMapper；当配置不为 null 时，type-key 无效 | -| spring.mongodb.type-key | String | _class | Type Key | \ No newline at end of file diff --git a/src/manual/0.0/mongodb/index.md b/src/manual/0.0/mongodb/index.md deleted file mode 100644 index ede421c..0000000 --- a/src/manual/0.0/mongodb/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-mongodb 参考手册 - - -`MongoDataAutoConfiguration` 扩展 。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-mongodb - x.x.x - -``` - - -您可以通过该类库，去掉 spring-data-mongodb 中的保存数据时的 _class 字段。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-mongodb/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/mybatis/ConfigurationProperties.md b/src/manual/0.0/mybatis/ConfigurationProperties.md deleted file mode 100644 index 86bcee7..0000000 --- a/src/manual/0.0/mybatis/ConfigurationProperties.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-mybatis 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.mybatis.config-location | String | -- | 配置文件路径 | -| spring.mybatis.check-config-location | boolean | false | 启动时是否检查 MyBatis XML 文件的存在 | -| spring.mybatis.mapper-locations | String[] | -- | Mapper 路径 | -| spring.mybatis.type-aliases-package | String | -- | MyBatis 映射类型别名包，通过该属性可以给包中的类注册别名，注册后在 Mapper 对应的 XML 文件中可以直接使用类名，而不用使用全限定的类名，即： XML 中调用的时候不用包含包名 | -| spring.mybatis.type-aliases-super-type | Class | -- | 该配置请和 typeAliasesPackage 一起使用，如果配置了该属性，则仅仅会扫描路径下以该类作为父类的域对象 | -| spring.mybatis.type-aliases | Class[] | -- | 类型别名包 | -| spring.mybatis.type-handlers-package | String | -- | TypeHandler 扫描路径，如果配置了该属性，SqlSessionFactoryBean 会把该包下面的类注册为对应的 TypeHandler | -| spring.mybatis.type-handlers | TypeHandler[] | -- | TypeHandler | -| spring.mybatis.default-enum-type-handler | Class>> | -- | TypeHandler | -| spring.mybatis.executor-type | org.apache.ibatis.session.ExecutorType | -- | 执行器类型 | -| spring.mybatis.configuration-properties | Properties | -- | 指定外部化 MyBatis Properties 配置，通过该配置可以抽离配置，实现不同环境的配置部署 | -| spring.mybatis.configuration | org.apache.ibatis.session.Configuration | -- | 原生 MyBatis 所支持的配置 | -| spring.mybatis.fail-fast | boolean | false | 是否启用快速失败机制 | \ No newline at end of file diff --git a/src/manual/0.0/mybatis/index.md b/src/manual/0.0/mybatis/index.md deleted file mode 100644 index ffc000b..0000000 --- a/src/manual/0.0/mybatis/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-mybatis 参考手册 - - -apache mybatis 自动配置类，支持一主多从 SqlSessionTemplate。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-mybatis - x.x.x - -``` - - -该模块实现了主从 apache mybatis `SqlSessionTemplate` 的初始化，配合 [buession-dao](https://www.buession.com/manual/2.3/dao/index.html) 使用。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-mybatis/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/pac4j/ConfigurationProperties.md b/src/manual/0.0/pac4j/ConfigurationProperties.md deleted file mode 100644 index 40ae2e7..0000000 --- a/src/manual/0.0/pac4j/ConfigurationProperties.md +++ /dev/null @@ -1,71 +0,0 @@ -# buession-springboot-pac4j 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.pac4j.clients | Set | -- | 启用认证的客户端类型名称，需要和各配置 [BaseConfig.BaseClientConfig](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/BaseConfig.BaseClientConfig.html) 类型中的名称保持一致 | -| spring.pac4j.default-client | String | -- | 默认客户端类型名称 | -| spring.pac4j.ajax-request-resolver-class | Class | com.buession.security.pac4j.http.JsonAjaxRequestResolver | Compute if a HTTP request is an AJAX one and the appropriate response. | -| spring.pac4j.multi-profile | boolean | false | 是否允许多个 Profile | -| spring.pac4j.save-in-session | boolean | true | 是否保存到 SESSION 中 | - - -#### 客户端配置 - -##### CAS 配置 - -1. spring.pac4j.client.cas.proxy.enabled：表示 pac4j `CasConfiguration` 是否启用 `CasProxyReceptor` - -详细配置参考 [https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Cas.html](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Cas.html) - - -##### HTTP 配置 - -详细配置参考 [https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Http.html](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Http.html) - - -##### JWT 配置 - -详细配置参考 [https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Jwt.html](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/Jwt.html) - - -##### OAuth 配置 - -详细配置参考 [https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/OAuth.html](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/com/buession/springboot/pac4j/config/OAuth.html) - -* 注：每类客户端均有 `enabled` 属性（如：spring.pac4j.client.cas.enabled），默认值为：false，表示是否启用该类客户端；每个客户端均有 `enabled` 属性（如：spring.pac4j.client.jwt.header.enabled），默认值为：false，表示是否启用该客户端. - - -#### Filter 配置 - -##### SecurityFilter 配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.pac4j.filter.security.name | String | -- | 过滤器名称 | -| spring.pac4j.filter.security.authorizers | Set | -- | 认证器名称列表 | -| spring.pac4j.filter.security.matchers | Set | -- | 匹配器名称列表 | - - -##### CallbackFilter 配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.pac4j.filter.callback.name | String | -- | 过滤器名称 | -| spring.pac4j.filter.callback.default-url | String | -- | 默认跳转地址 | - - -##### LogoutFilter 配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.pac4j.filter.logout.name | String | -- | 过滤器名称 | -| spring.pac4j.filter.logout.default-url | String | -- | 登出成功默认跳转地址 | -| spring.pac4j.filter.logout.logout-url-pattern | String | -- | 登出地址模式 | -| spring.pac4j.filter.logout.local-logout | boolean | true | 本地是否退出登录 | -| spring.pac4j.filter.logout.central-logout | boolean | true | 认证中心是否退出登录 | \ No newline at end of file diff --git a/src/manual/0.0/pac4j/index.md b/src/manual/0.0/pac4j/index.md deleted file mode 100644 index b77fc36..0000000 --- a/src/manual/0.0/pac4j/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-pac4j 参考手册 - - -pac4j && buession-security-pac4j 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-pac4j - x.x.x - -``` - - -该模块实现了主从 pac4j client, buji-pac4j filter 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-pac4j/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/session/ConfigurationProperties.md b/src/manual/0.0/session/ConfigurationProperties.md deleted file mode 100644 index 95d7b9f..0000000 --- a/src/manual/0.0/session/ConfigurationProperties.md +++ /dev/null @@ -1,7 +0,0 @@ -# buession-springboot-session 参考手册 - - -## 配置属性 - - -无 \ No newline at end of file diff --git a/src/manual/0.0/session/index.md b/src/manual/0.0/session/index.md deleted file mode 100644 index 72a88b8..0000000 --- a/src/manual/0.0/session/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-session 参考手册 - - -buession-session 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-session - x.x.x - -``` - - -该模块实现了[buession-session](https://www.buession.com/manual/2.3/session/index.html) 的初始化，无实际意义，后续将会删除。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-session/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/shiro/ConfigurationProperties.md b/src/manual/0.0/shiro/ConfigurationProperties.md deleted file mode 100644 index d49d8e2..0000000 --- a/src/manual/0.0/shiro/ConfigurationProperties.md +++ /dev/null @@ -1,41 +0,0 @@ -# buession-springboot-shiro 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.shiro.login-url | String | -- | 登录地址 | -| spring.shiro.success-url | String | -- | 登录成功跳转地址 | -| spring.shiro.unauthorized-url | String | -- | 授权失败跳转地址 | -| spring.shiro.annotations.enabled | boolean | true | 是否开启 Shiro 注解 | -| spring.shiro.web.enabled | boolean | true | 是否开启 Shiro WEB 模式 | -| spring.shiro.enabled | boolean | true | 是否开启 Shiro | -| spring.shiro.session.use-native-session-manager | boolean | false | 是否使用原生 Session 管理器 | -| spring.shiro.session.session-id-cookie-enabled | boolean | true | 是否开启 SESSION ID Cookie | -| spring.shiro.session.session-id-url-rewriting-enabled | boolean | true | 是否开启 URL 重写，开启后 URL 中会带 JSESSIONID | -| spring.shiro.session.session-in-memory-enabled | boolean | true | 是否开启 Session 在内存中保存 | -| spring.shiro.session.session-in-memory-timeout | long | 1000 | Session 在内存中保存超时时间（单位：毫秒） | -| spring.shiro.session.prefix | String | shiro:session: | Session 名称前缀 | -| spring.shiro.session.expire | int | -2 | Session 有效期，当为 -2 时，则为 Session timeout 的值；为 -1 时，表示永不过期 | -| spring.shiro.session.session-manager-delete-invalid-sessions | boolean | true | 如果 Session 过期或者无效后，是否删除 | -| spring.shiro.session.cookie.name | String | JSESSIONID | Session Cookie 名称 | -| spring.shiro.session.cookie.domain | String | -- | Session Cookie 作用域 | -| spring.shiro.session.cookie.path | String | -- | Session Cookie 作用路径 | -| spring.shiro.session.cookie.max-age | Integer | -1 | Session Cookie 最大有效期 | -| spring.shiro.session.cookie.secure | Boolean | false | Session Cookie 是否启用安全 Cookie | -| spring.shiro.session.cookie.http-only | Boolean | -- | Session Cookie 是否开启 HttpOnly | -| spring.shiro.session.cookie.same-site | com.buession.web.http.SameSite | -- | Session Cookie 限制第三方 Cookie 方式 | -| spring.shiro.cache.prefix | String | shiro:cache: | 缓存 Key 前缀 | -| spring.shiro.cache.expire | int | 1800 | 缓存过期时间 | -| spring.shiro.cache.principal-id-field-name | String | id | Principal Id | -| spring.shiro.remember-me.cookie.name | String | rememberMe | 记住我 Cookie 名称 | -| spring.shiro.remember-me.cookie.domain | String | -- | 记住我 Cookie 作用域 | -| spring.shiro.remember-me.cookie.path | String | -- | 记住我 Cookie 作用路径 | -| spring.shiro.remember-me.cookie.max-age | Integer | 31536000 | 记住我 Cookie 最大有效期 | -| spring.shiro.remember-me.cookie.secure | Boolean | false | 记住我 Cookie 是否启用安全 Cookie | -| spring.shiro.remember-me.cookie.http-only | Boolean | -- | 记住我 Cookie 是否开启 HttpOnly | -| spring.shiro.remember-me.cookie.same-site | com.buession.web.http.SameSite | -- | 记住我 Cookie 限制第三方 Cookie 方式 | \ No newline at end of file diff --git a/src/manual/0.0/shiro/index.md b/src/manual/0.0/shiro/index.md deleted file mode 100644 index 845af38..0000000 --- a/src/manual/0.0/shiro/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-shiro 参考手册 - - -apache shiro && buession-security-shiro 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-shiro - x.x.x - -``` - - -该模块实现了[buession-security-shiro](https://security.buession.com/manual/2.3/shiro/index.html) 和 apache shiro 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-shiro/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/cli/ConfigurationProperties.md b/src/manual/0.0/spring/ConfigurationProperties.md similarity index 100% rename from src/manual/0.0/cli/ConfigurationProperties.md rename to src/manual/0.0/spring/ConfigurationProperties.md diff --git a/src/manual/0.0/spring/index.md b/src/manual/0.0/spring/index.md new file mode 100644 index 0000000..efb580c --- /dev/null +++ b/src/manual/0.0/spring/index.md @@ -0,0 +1,23 @@ +# buession-canal-spring 参考手册 + + +buession canal springframework 支持。 + + +--- + + +### 安装 + +```xml + + com.buession.canal + buession-canal-spring + x.x.x + +``` + +该模块主要为对 springframework 支持。 + + +### [API 参考手册>>](https://javadoc.io/static/com.buession.canal/buession-canal-spring/0.0.1/) \ No newline at end of file diff --git a/src/manual/0.0/velocity/ConfigurationProperties.md b/src/manual/0.0/velocity/ConfigurationProperties.md deleted file mode 100644 index 88d11c2..0000000 --- a/src/manual/0.0/velocity/ConfigurationProperties.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-velocity 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| spring.velocity.enabled | boolean | true | 是否启用 | -| spring.velocity.prefix | String | "" | 模板前缀 | -| spring.velocity.suffix | String | .vm | 模板后缀 | -| spring.velocity.date-tool-attribute | String | -- | 日期时间工具属性 | -| spring.velocity.number-tool-attribute | String | -- | 数字工具属性 | -| spring.velocity.properties | Map | -- | Velocity 属性 | -| spring.velocity.resource-loader-path | String | classpath:/Templates/ | 模板目录路径 | -| spring.velocity.toolbox-config-location | String | -- | toolbox 配置文件路径 | -| spring.velocity.prefer-file-system-access | boolean | true | 是否预检文件权限 | -| spring.velocity.cache | boolean | false | 是否缓存 | -| spring.velocity.content-type | org.springframework.util.MimeType | text/html | Content-Type | -| spring.velocity.charset | java.nio.charset.Charset | UTF-8 | 字符集 | -| spring.velocity.velocity-macro.library | String | -- | 宏文件路径 | \ No newline at end of file diff --git a/src/manual/0.0/velocity/index.md b/src/manual/0.0/velocity/index.md deleted file mode 100644 index ec5ab3d..0000000 --- a/src/manual/0.0/velocity/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# buession-springboot-velocity 参考手册 - - -apache velocity && buession-velocity 自动配置类。 - - ---- - - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-velocity - x.x.x - -``` - - -该模块实现了[buession-velocity](https://www.buession.com/manual/2.3/velocity/index.html) 和 apache velocity 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-velocity/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/web/ConfigurationProperties.md b/src/manual/0.0/web/ConfigurationProperties.md deleted file mode 100644 index a8bbf46..0000000 --- a/src/manual/0.0/web/ConfigurationProperties.md +++ /dev/null @@ -1,65 +0,0 @@ -# buession-springboot-web 参考手册 - - -## 配置属性 - - -#### 通用配置 - -| 属性 | 类型 | 默认值 | 说明 | -| ---- | ---- | ---- | ---- | -| server.response-headers | LinkedHashMap | -- | 自定义响应头 | -| server.server-info-name | String | -- | Server 信息响应头名称 | -| server.server-info-prefix | String | -- | Server 信息响应头前缀 | -| server.server-info-suffix | String | -- | Server 信息响应头后缀 | -| server.strip-server-info-prefix | String | -- | 删除 Server 信息响应头前缀 | -| server.strip-server-info-suffix | String | -- | 删除 Server 信息响应头后缀 | -| server.poweredby.enabled | boolean | true | 响应头中是否输出 PoweredBy 信息 | -| server.server-info.enabled | boolean | true | 响应头中是否输出 Server 信息 | -| server.print-url.enabled | boolean | false | 是否打印当前 URL | -| spring.security.enabled | boolean | true | 是否启用安全设置 | -| spring.security.disable-defaults | boolean | false | 是否禁用 spring security 默认配置 | -| spring.security.http-basic.enabled | boolean | false | 是否启用 Http Basic 验证 | -| spring.security.csrf.enabled | boolean | true | 是否启用 Csrf | -| spring.security.csrf.mode | com.buession.security.web.config.CsrfMode | -- | Csrf 模式 | -| spring.security.csrf.cookie.parameter-name | String | _csrf | Csrf 请求参数名 | -| spring.security.csrf.cookie.header-name | String | X-Xsrf-Token | Csrf 请求头名称 | -| spring.security.csrf.cookie.cookie-name | String | XSRF-TOKEN | Csrf Cookie 名称 | -| spring.security.csrf.cookie.cookie-domain | String | -- | Csrf Cookie 作用域 | -| spring.security.csrf.cookie.cookie-path | String | -- | Csrf Cookie 作用路径 | -| spring.security.csrf.cookie.cookie-http-only | boolean | true | Csrf Cookie 是否可通过客户端脚本访问 | -| spring.security.csrf.session.parameter-name | String | _csrf | Csrf 请求参数名 | -| spring.security.csrf.session.header-name | String | X-Xsrf-Token | Csrf 请求头名称 | -| spring.security.csrf.session.session-attribute-name | String | org.springframework.security.web.csrf.HttpSessionCsrfTokenRepository.CSRF_TOKEN | Csrf Session 属性名称 | -| spring.security.csrf.frame-options.enabled | boolean | true | 是否启用 Frame Options | -| spring.security.csrf.frame-options.mode | com.buession.security.web.config.XFrameOptionsMode | XFrameOptionsMode.DENY | Frame Options 模式 | -| spring.security.hsts.enabled | boolean | true | 是否启用 Hsts | -| spring.security.hsts.matcher | Class | -- | Request 匹配器 | -| spring.security.hsts.max-age | long | 31536000 | 缓存时间，在浏览器收到这个请求后的 maxAge 秒的时间内凡是访问这个域名下的请求都使用HTTPS请求 | -| spring.security.hsts.include-sub-domains | Boolean | -- | 配置此规则也适用于该网站的所有子域名 | -| spring.security.hsts.preload | Boolean | -- | 是否预加载 HSTS | -| spring.security.hpkp.enabled | boolean | true | 是否启用 Hpkp | -| spring.security.hpkp.pins | Map | -- | | -| spring.security.hpkp.sha256-pins | String[] | -- | | -| spring.security.hpkp.max-age | Long | -- | 浏览器应记住仅使用其中一个已定义的密钥访问此站点的时间 | -| spring.security.hpkp.include-sub-domains | Boolean | -- | 配置此规则也适用于该网站的所有子域名 | -| spring.security.hpkp.report-only | Boolean | -- | | -| spring.security.hpkp.report-uri | String | -- | | -| spring.security.content-security-policy.enabled | boolean | true | 是否启用 ContentSecurityPolicy | -| spring.security.content-security-policy.report-only | Boolean | -- | | -| spring.security.content-security-policy.policy-directives | String | -- | ContentSecurityPolicy 策略 | -| spring.security.referrer-policy.enabled | boolean | true | 是否启用 ReferrerPolic | -| spring.security.referrer-policy.policy | com.buession.security.web.config.ReferrerPolicy.Policy | ReferrerPolicy.Policy.NO_REFERRER | | -| spring.security.xss.enabled | boolean | true | 是否启用 XSS 防护 | -| spring.security.xss.block | Boolean | -- | | -| spring.security.xss.enabled-protection | Boolean | -- | | -| spring.security.xss.policy-config-location | String | -- | XSS 策略配置文件路径 | -| spring.security.cors.enabled | boolean | true | 是否启用 Cors | -| spring.security.cors.origins | Set | -- | 允许请求的域 | -| spring.security.cors.allowed-methods | Set | -- | 允许请求的方法 | -| spring.security.cors.allowed-headers | Set | -- | 实际请求中允许携带的首部字段 | -| spring.security.cors.exposed-headers | Set | -- | 允许浏览器访问的头 | -| spring.security.cors.allow-credentials | Boolean | -- | 当浏览器的 credentials 设置为 true 时是否允许浏览器读取 response 的内容 | -| spring.security.cors.max-age | Long | -- | 指定了 preflight 请求的结果能够被缓存时间（单位：秒 | -| spring.security.form-login.enabled | boolean | false | 是否启动登录表单 | -| spring.security.form-login.login-page | String | -- | 登录页地址 | \ No newline at end of file diff --git a/src/manual/0.0/web/index.md b/src/manual/0.0/web/index.md deleted file mode 100644 index 9c787d0..0000000 --- a/src/manual/0.0/web/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# buession-springboot-web 参考手册 - - -buession-web 自动配置类。 - - ---- - -### 安装 - -```xml - - com.buession.springboot - buession-springboot-web - x.x.x - -``` - - -该模块实现了[buession-web](https://www.buession.com/manual/2.3/web/index.html) 的初始化。 - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-web/2.3.0/) \ No newline at end of file diff --git a/src/manual/0.0/web/startup.md b/src/manual/0.0/web/startup.md deleted file mode 100644 index fadd58a..0000000 --- a/src/manual/0.0/web/startup.md +++ /dev/null @@ -1,94 +0,0 @@ -# buession-springboot-web 参考手册 - - -Spring Boot Web 应用启动类。 - - ---- - - -```java -package com.example; - -import com.buession.springboot.boot.application.Application; -import com.buession.springboot.web.application.AbstractWebApplication; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.WebApplicationType; -import org.springframework.context.annotation.EnableAspectJAutoProxy; - -@SpringBootApplication(scanBasePackages = {"com.example"}, exclude = {}) -@EnableAspectJAutoProxy(proxyTargetClass = true) -public class ExampleWebApplication extends AbstractWebApplication { - - protected ExampleWebApplication() { - super(new ExampleBanner()); - } - - public static void main(final String[] args) { - Application application = new ExampleWebApplication(); - application.startup(args); - } - -} - -``` - -初始化 Servlet 应用： - -```java -package com.example; - -import com.buession.springboot.boot.application.Application; -import com.buession.springboot.web.application.AbstractWebApplication; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.WebApplicationType; -import org.springframework.context.annotation.EnableAspectJAutoProxy; - -@SpringBootApplication(scanBasePackages = {"com.example"}, exclude = {}) -@EnableAspectJAutoProxy(proxyTargetClass = true) -public class ServletExampleWebApplication extends AbstractWebApplication { - - protected ServletExampleWebApplication() { - super(WebApplicationType.SERVLET, new ServletExampleBanner()); - } - - public static void main(final String[] args) { - Application application = new ServletExampleWebApplication(); - application.startup(args); - } - -} - -``` - - -初始化 Reactive 应用： - -```java -package com.example; - -import com.buession.springboot.boot.application.Application; -import com.buession.springboot.web.application.AbstractWebApplication; -import org.springframework.boot.autoconfigure.SpringBootApplication; -import org.springframework.boot.WebApplicationType; -import org.springframework.context.annotation.EnableAspectJAutoProxy; - -@SpringBootApplication(scanBasePackages = {"com.example"}, exclude = {}) -@EnableAspectJAutoProxy(proxyTargetClass = true) -public class ReactiveExampleWebApplication extends AbstractWebApplication { - - protected ReactiveExampleWebApplication() { - super(WebApplicationType.REACTIVE, new ServletExampleBanner()); - } - - public static void main(final String[] args) { - Application application = new ReactiveExampleWebApplication(); - application.startup(args); - } - -} - -``` - - -### [API 参考手册>>](https://javadoc.io/static/com.buession.springboot/buession-springboot-web/2.3.0/com/buession/springboot/web/application/AbstractWebApplication.html) \ No newline at end of file diff --git a/src/manual/SUMMARY.md b/src/manual/SUMMARY.md index 8160526..1e00ef4 100644 --- a/src/manual/SUMMARY.md +++ b/src/manual/SUMMARY.md @@ -6,7 +6,7 @@ * [buession-canal-annotation](0.0/annotation/index.md) * [安装](0.0/annotation/index.md#安装) * [注解说明](0.0/annotation/annotation.md) - * [bbuession-canal-core](0.0/core/index.md) + * [buession-canal-core](0.0/core/index.md) * [安装](0.0/core/index.md#安装) * [buession-canal-client](0.0/client/index.md) * [安装](0.0/client/index.md#安装)