Skip to content

Commit f106b52

Browse files
authored
docs: add docs for using shared objects within the plugin (#451)
### What this PR does? 完善 Halo 共享给插件的 Beans 列表和使用文档 ```release-note None ```
1 parent cd44c8b commit f106b52

File tree

3 files changed

+398
-24
lines changed

3 files changed

+398
-24
lines changed

docs/developer-guide/plugin/basics/server/object-management.md

+199-12
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,205 @@ public class Demo {
4040
}
4141
```
4242

43-
### 依赖注入 Halo 提供的 Bean
43+
## 依赖注入 Halo 共享的 Bean
4444

45-
目前 Halo 只提供了少数几个 Bean 可以供插件依赖注入:
45+
Halo 提供了一些共享的 Bean,任何插件都可以直接依赖注入这些 Bean。
4646

47-
- run.halo.app.extension.ReactiveExtensionClient:用于管理自定义模型对象的增删改查,它是反应式的。
48-
- run.halo.app.extension.ExtensionClient:用于管理自定义模型对象的增删改查,它是阻塞的,只能用在非 NIO 线程中,如后台任务。
49-
- run.halo.app.extension.SchemeManager:用于管理自定义模型定义的注册和销毁。
50-
- run.halo.app.infra.ExternalUrlSupplier:用于获取用户配置的 Halo 外部访问地址。
51-
- run.halo.app.core.extension.service.AttachmentService:用于操作附件。
52-
- run.halo.app.notification.NotificationReasonEmitter:用于发送通知。
53-
- run.halo.app.notification.NotificationCenter:用于管理通知的订阅和取消订阅。
54-
- run.halo.app.infra.ExternalLinkProcessor:用于处理将一个相对地址转换为外部访问地址。
55-
- org.springframework.security.web.server.context.ServerSecurityContextRepository:用于获取操作用户的认证上下文信息,如自动登录场景。
47+
### ReactiveExtensionClient
5648

57-
即其他不在上述列表中的类的对象都是不可依赖注入的。
49+
`ReactiveExtensionClient` 是一个用于管理自定义模型对象的增删改查的 Bean,它是反应式的。
50+
51+
参考 [与自定义模型交互](../../api-reference/server/extension-client.md) 了解更多。
52+
53+
### ExtensionClient
54+
55+
`ExtensionClient` 作用和方法与 ReactiveExtensionClient 一样,但它是阻塞的,只能用在非 NIO 线程中,如后台任务。
56+
57+
### SchemeManager
58+
59+
`SchemeManager` 是一个用于管理自定义模型定义的注册和销毁的 Bean。
60+
61+
API 参考:[SchemeManager](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/extension/SchemeManager.java)
62+
63+
### UserService
64+
65+
用于操作 Halo 用户的 Bean,包括获取用户信息、更新密码、创建用户等函数。
66+
67+
API 参考 [UserService](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/core/user/service/UserService.java)
68+
69+
### ReactiveUserDetailsService
70+
71+
用于获取用户信息的 Bean,它只有一个方法 `Mono<UserDetails> findByUsername(String username)`
72+
73+
### RoleService
74+
75+
用于操作 Halo 角色的 Bean,包括查询角色绑定、角色及依赖等函数。
76+
77+
API 参考 [RoleService](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/core/user/service/RoleService.java)
78+
79+
### AttachmentService
80+
81+
用于操作 Halo 附件的 Bean,包括上传、删除附件以及获取附件访问链接等函数。
82+
83+
API 参考 [AttachmentService](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java)
84+
85+
### PostContentService
86+
87+
在 Halo 中,文章内容具有版本管理的概念。第一个版本是完整的文章内容,称为 `baseSnapshot`。从第二个版本开始,每个版本都是基于 `baseSnapshot` 的增量内容。因此,要查询完整的文章内容,需要获取 `baseSnapshot` 以及对应的版本增量内容并合并。
88+
89+
![文章内容版本模型](/img/developer-guide/plugin/basic/server/post-content-version-generation.png)
90+
91+
为了方便插件开发者获取文章内容,Halo 提供了 `PostContentService`,以简化这一过程的复杂性。
92+
93+
- getHeadContent:获取文章的最新版本内容(包括正在编辑的草稿)。
94+
- getReleaseContent:获取最新发布的文章内容。
95+
- getSpecifiedContent:获取指定 snapshotName 对应的文章内容。
96+
- listSnapshots:获取指定文章的所有版本的 Snapshot 对象的名称列表。
97+
98+
API 参考:[PostContentService](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/content/PostContentService.java)
99+
文章自定义模型定义参考 [Post](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/core/extension/content/Post.java)
100+
101+
### NotificationReasonEmitter
102+
103+
用于发送通知事件的 Bean。
104+
105+
#### 使用示例
106+
107+
假如有一个 `NEW_COMMENT_ON_POST` 文章有新评论的通知事件,你可以这样发送通知:
108+
109+
```java
110+
Mono<Void> emitNewCommentOnPostReason(/* 此示例省略参数 */) {
111+
return notificationReasonEmitter.emit(NotificationReasonConst.NEW_COMMENT_ON_POST,
112+
builder -> {
113+
// 填充事件的数据
114+
var attributes = CommentOnPostReasonData.builder()
115+
.postName(subjectRef.getName())
116+
.postOwner(post.getSpec().getOwner())
117+
.postTitle(post.getSpec().getTitle())
118+
.postUrl(postUrl)
119+
.commenter(owner.getDisplayName())
120+
.content(comment.getSpec().getContent())
121+
.commentName(comment.getMetadata().getName())
122+
.build();
123+
builder.attributes(ReasonDataConverter.toAttributeMap(attributes))
124+
.author(identityFrom(owner))
125+
.subject(reasonSubject);
126+
})
127+
}
128+
```
129+
130+
API 参考:[NotificationReasonEmitter](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/notification/NotificationReasonEmitter.java)
131+
132+
### NotificationCenter
133+
134+
用于管理通知的订阅和取消订阅。
135+
136+
API 参考:[NotificationCenter](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/notification/NotificationCenter.java)
137+
138+
### ExternalLinkProcessor
139+
140+
用于将一个站内相对链接转换为绝对链接。
141+
142+
如配置了外部访问地址为 `https://example.com`,那么将 `/post/1` 转换为 `https://example.com/post/1`
143+
144+
API 参考:[ExternalLinkProcessor](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/infra/ExternalLinkProcessor.java);
145+
146+
### LoginHandlerEnhancer
147+
148+
Halo 提供了登录增强机制,插件可以在登录成功或失败时调用登录增强器,使 Halo 可以执行额外的处理逻辑。
149+
150+
参考 [登录增强器](../../api-reference/server/login-handler-enhancer.md) 了解更多。
151+
152+
使用示例参考 [用户名密码登陆成功和失败的增强切入示例](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/application/src/main/java/run/halo/app/security/authentication/login/UsernamePasswordHandler.java#L106)
153+
154+
### BackupRootGetter
155+
156+
用于获取 Halo 备份文件的根目录。它是 `Supplier<Path>` 的子类。
157+
158+
### PluginsRootGetter
159+
160+
用于获取 Halo 插件的根目录。它是 `Supplier<Path>` 的子类。
161+
162+
### ExtensionGetter
163+
164+
用于获取扩展点实例(扩展)的 Bean。
165+
166+
例如,Halo 定义了 `AttachmentHandler` 这个扩展点,你可以通过 `ExtensionGetter` 获取到所有实现了 `AttachmentHandler` 接口的扩展。
167+
168+
有了它,插件中便可以定义自己的扩展点,然后由其他插件实现以达到插件扩展插件的目的。
169+
170+
API 参考 [ExtensionGetter](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/plugin/extensionpoint/ExtensionGetter.java)
171+
172+
### ServerSecurityContextRepository
173+
174+
用于获取操作用户的认证上下文信息,如登录成功后保存认证信息。
175+
176+
ServerSecurityContextRepository 被 [ReactorContextWebFilter](https://github.com/spring-projects/spring-security/blob/9d2ca3da6a285f31ebd2da5f019127e1527e5042/web/src/main/java/org/springframework/security/web/server/context/ReactorContextWebFilter.java) 使用来获取操作用户的认证上下文信息并填充到 ReactiveSecurityContextHolder 中。
177+
此过滤器的执行顺序在 [SecurityWebFiltersOrder](https://github.com/spring-projects/spring-security/blob/9d2ca3da6a285f31ebd2da5f019127e1527e5042/config/src/main/java/org/springframework/security/config/web/server/SecurityWebFiltersOrder.java#L47) 中定义。因此如果你的过滤器在此过滤器之前执行,那么你将无法从 ReactiveSecurityContextHolder 中获取到操作用户的认证上下文信息只能通过注入 ServerSecurityContextRepository 来获取。
178+
179+
API 参考:[ServerSecurityContextRepository](https://docs.spring.io/spring-security/site/docs/current/api/org/springframework/security/web/server/context/ServerSecurityContextRepository.html)
180+
181+
### CryptoService
182+
183+
Halo 根据用户名密码登录时,会先使用 CryptoService 的 `readPublicKey` 方法读取公钥,然后使用公钥加密密码,再发送给服务器。
184+
185+
当插件需要添加一些拦截器处理登录请求时可能需要获取原始密码,此时可以使用 CryptoService 的 `decrypt` 方法解密密码。
186+
187+
也可以复用它的公钥来作为一些加密算法的密钥。
188+
189+
API 参考 [CryptoService](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/security/authentication/CryptoService.java)
190+
191+
### ExternalUrlSupplier
192+
193+
`ExternalUrlSupplier` 是一个用于获取用户配置的 Halo 外部访问地址的 Bean。
194+
195+
API 参考:[ExternalUrlSupplier](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/api/src/main/java/run/halo/app/infra/ExternalUrlSupplier.java)
196+
197+
### RateLimiterRegistry
198+
199+
`RateLimiterRegistry` 是一个用于管理限流器的 Bean。
200+
201+
如果插件定义的某些 API 需要限流,可以使用 `RateLimiterRegistry` 来创建一个限流器,但是需要注意的是,**必须要在插件停止的生命周期方法里销毁你所创建的限流器**,否则会导致内存泄漏。
202+
203+
#### 使用示例
204+
205+
以下示例展示了如何使用 `RateLimiterRegistry` 创建一个限流器:
206+
207+
```java
208+
final Set<String> limiterNames = new HashSet<>();
209+
210+
Mono<Void> sendEmailVerificationCode(String username, String email) {
211+
return buildSendEmailRateLimiter(username, email) // step 1: 构建一个限流器
212+
.transformDeferred(rateLimiter -> rateLimiter.map(RateLimiterOperator::of)) // step 2: 返回一个经过变换的新 Mono
213+
// step 3: 从这里开始的操作符都会受到限流的影响
214+
.flatMap(rateLimiter -> emailVerificationService.sendVerificationCode(username, email))
215+
// 转换 RequestNotPermitted 为 RateLimitExceededException 以使全局异常处理器能够处理
216+
.onErrorMap(RequestNotPermitted.class, RateLimitExceededException::new);
217+
}
218+
219+
RateLimiter buildSendEmailRateLimiter(String username, String email) {
220+
var rateLimiterKey = "send-email-verification-code-" + username + ":" + email;
221+
var rateLimiter = rateLimiterRegistry.rateLimiter(rateLimiterKey, new RateLimiterConfig.Builder()
222+
// 频次限制为 1 次
223+
.limitForPeriod(1)
224+
// 限制刷新周期为 60 秒, 即 60 秒内只能执行 1 次
225+
.limitRefreshPeriod(Duration.ofSeconds(60))
226+
.build());
227+
// 添加 limiter 到自己实现的 Registry 中保存起来以便在插件停止时清理
228+
limiters.add(rateLimiterKey);
229+
return limiter;
230+
}
231+
```
232+
233+
在插件停止的生命周期方法里销毁你所创建的限流器:
234+
235+
```java
236+
@Override
237+
public void stop() {
238+
limiters.forEach(rateLimiterRegistry::remove);
239+
}
240+
```
241+
242+
`transformDeferred` 的作用是将 Mono 传入你提供的变换器中,返回一个经过变换的新 Mono。由于 RateLimiterOperator 是基于 Publisher 的装饰器(decorator),它会监视这个 Mono 的订阅和执行情况,从而对整个 Mono 的操作链进行限流。
243+
244+
换句话说,因为 `RateLimiterOperator` 装饰了这个 Mono,所以任何接在 `transformDeferred()` 之后的操作符都会受到限流的影响,直到整个流结束。
Loading

0 commit comments

Comments
 (0)