Contribute to this guideReport an issue

guide入门

如果您想直接进入重点并查看一个带有工作 CKFinder 的应用程序示例,请查看CKFinder 3 for Java - 演示应用程序仓库。

# 1. 将 CKSource Maven 仓库添加到您的项目

Gradle

// build.gradle
repositories {
    mavenCentral()
    maven {
        url = 'https://maven.cksource.com/'
    }
}

Maven

<!-- pom.xml -->
<repository>
    <id>cksource-mvn-repo</id>
    <name>CKSource Maven Repository</name>
    <url>https://maven.cksource.com/</url>
</repository>

# 2. 在项目依赖项中添加 CKFinder

Gradle

// build.gradle
dependencies {
    compile 'com.cksource:ckfinder3:4.0.1'
}

Maven

<!-- pom.xml -->
<dependency>
    <groupId>com.cksource</groupId>
    <artifactId>ckfinder3</artifactId>
    <version>4.0.1</version>
</dependency>

# 3. 在您的配置中启用 CKFinder servlet

<!-- web.xml -->
<servlet>
    <servlet-name>CKFinder</servlet-name>
    <servlet-class>com.cksource.ckfinder.servlet.CKFinderServlet</servlet-class>
    <multipart-config>
        <location>/tmp</location>
        <max-file-size>5242880</max-file-size><!--5MB-->
        <max-request-size>20971520</max-request-size><!--20MB-->
        <file-size-threshold>0</file-size-threshold>
    </multipart-config>
</servlet>

<servlet-mapping>
    <servlet-name>CKFinder</servlet-name>
    <url-pattern>/ckfinder/*</url-pattern>
</servlet-mapping>

请注意,多部分配置是强制性的。没有它,CKFinder 中的文件上传将无法工作。

以上示例假设 servlet 在 web.xml 文件中注册,但您可能希望以其他方式注册它。这里您可以阅读有关 servlet 注册方法的更多信息。

# 4. 添加配置文件并调整配置选项

此时,您需要更改配置选项以配置 CKFinder 使用的路径,定义访问权限,文件扩展名白名单等。

默认情况下,CKFinder 连接器在应用程序资源中查找名为 ckfinder.yml 的配置文件。这里您可以找到此配置文件的模板。

如果您想从任何其他位置加载配置,请查看从自定义位置加载配置教程。

在 CKFinder 管理的文件通过 Web 服务器提供服务的情况下,建议执行一些服务器配置微调,以确保以安全的方式提供文件。要了解更多信息,请参阅保护可公开访问的文件夹文章。

# 5. 配置身份验证

通常,您希望限制对 CKFinder 的访问,以便只有您的应用程序的已验证用户才能上传或浏览文件。您可以通过实现自定义 Authenticator 来实现此目的。

要了解更多信息,请参阅配置身份验证教程。

# 演示应用程序

查看在 Spring Boot 应用程序中基本设置 CKFinder 的示例.

请注意,使用 CKFinder 不需要 Spring Boot,您可以像任何其他常规 servlet 一样设置它。如果您想了解更多关于 servlet 注册方法的信息,请参阅 Baeldung 的如何在 Java 中注册 Servlet文章。