docs: add docs for plugin ExtensionGetter (#388)

#### What this PR does / why we need it:

添加 ExtensionGetter 的开发者文档及示例。

see https://github.com/halo-dev/halo/pull/6365

#### Does this PR introduce a user-facing change?
```release-note
None
```
main
Takagi 8 months ago committed by GitHub
parent 64d482f224
commit 017ec7aaa9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,6 +1,6 @@
---
title: 与自定义模型交互
description: 了解如通过代码的方式操作数据
description: 了解如通过代码的方式操作数据
---
Halo 提供了两个类用于与自定义模型对象交互 `ExtensionClient``ReactiveExtensionClient`

@ -0,0 +1,72 @@
---
title: 获取扩展
description: 了解如何在插件中使用 `ExtensionGetter` 获取扩展
---
`ExtensionGetter` 用于获取和管理 Halo 或其他插件提供的扩展。它提供了多种方法来根据扩展点获取扩展,确保插件能够灵活地集成和使用各种扩展功能。
`ExtensionGetter` 接口的定义如下:
```java
public interface ExtensionGetter {
/**
* Get only one enabled extension from system configuration.
*
* @param extensionPoint is extension point class.
* @return implementation of the corresponding extension point. If no configuration is found,
* we will use the default implementation from application context instead.
*/
<T extends ExtensionPoint> Mono<T> getEnabledExtension(Class<T> extensionPoint);
/**
* Get the extension(s) according to the {@link ExtensionPointDefinition} queried
* by incoming extension point class.
*
* @param extensionPoint extension point class
* @return implementations of the corresponding extension point.
* @throws IllegalArgumentException if the incoming extension point class does not have
* the {@link ExtensionPointDefinition}.
*/
<T extends ExtensionPoint> Flux<T> getEnabledExtensions(Class<T> extensionPoint);
/**
* Get all extensions according to extension point class.
*
* @param extensionPointClass extension point class
* @param <T> type of extension point
* @return a bunch of extension points.
*/
<T extends ExtensionPoint> Flux<T> getExtensions(Class<T> extensionPointClass);
}
```
包含以下方法:
1. `getEnabledExtension(Class<T> extensionPoint)`: 获取一个在扩展设置中已启用的扩展。如果没有找到对应配置,将使用 Halo 中的默认扩展,如果 Halo 没有提供默认实现则找到一个由**已启用插件**提供的可用扩展。
2. `getEnabledExtensions(Class<T> extensionPoint)`: 根据传入的扩展点类获取所有已启用扩展。如果没有在扩展设置页面配置过则会返回所有可用的扩展。
3. `getExtensions(Class<T> extensionPointClass)`: 获取所有与扩展点类相关的扩展,无论是否在扩展设置中启用它。
:::tip Note
使用 `getEnabledExtension` 方法或者 `getEnabledExtensions` 方法取决于扩展点声明的 `type``SINGLETON` 还是 `MULTI_INSTANCE`
通过使用 `ExtensionGetter`,开发者可以轻松地在插件中访问和管理各种扩展点,提升插件的功能和灵活性。
如果想了解 Halo 提供的扩展点请参考:[扩展点](./extension-points/index.md)。
:::
### 示例
如果你想在插件中获取已启用的搜索引擎扩展,可以使用 `ExtensionGetter` 来获取:
```java
@Service
@RequiredArgsConstructor
public class SearchService {
private final ExtensionGetter extensionGetter;
Mono<SearchEngine> getSearchEngine() {
return extensionGetter.getEnabledExtension(SearchEngine.class)
}
}
```

@ -1,6 +1,6 @@
---
title: 静态资源代理
description: 了解如使用静态资源代理来访问插件中的静态资源
description: 了解如使用静态资源代理来访问插件中的静态资源
---
插件中的静态资源如图片等如果想被外部访问到,需要放到 `src/main/resources` 目录下,并通过创建 `ReverseProxy` 自定义模型对象来进行静态资源代理访问。

@ -1,6 +1,6 @@
---
title: API 权限控制
description: 了解如对插件中的 API 定义角色模板以接入权限控制
description: 了解如对插件中的 API 定义角色模板以接入权限控制
---
插件中的 APIs 无论是自定义模型自动生成的 APIs 或者是通过 `@Controller` 自定义的 APIs 都只有超级管理员能够访问,如果想将这些 APIs 授权给其他用户访问,

@ -185,6 +185,7 @@ module.exports = {
"developer-guide/plugin/api-reference/server/template-for-theme",
"developer-guide/plugin/api-reference/server/websocket",
"developer-guide/plugin/api-reference/server/login-handler-enhancer",
"developer-guide/plugin/api-reference/server/extension-getter",
{
type: "category",
label: "扩展点",

Loading…
Cancel
Save