mirror of
https://github.com/KOHGYLW/kiftd-source.git
synced 2025-01-08 12:07:47 +08:00
77 lines
5.0 KiB
Markdown
77 lines
5.0 KiB
Markdown
## 欢迎访问kiftd源代码资源库！
|
||
### Welcome to visit source of kiftd!
|
||
|
||
_当前版本：v1.2.3-SNAPSHOT_
|
||
|
||
### 简介
|
||
_kiftd——一款便捷、开源、功能完善的个人&团队&小型团队网盘服务器系统。_
|
||
|
||
------
|
||
[](https://postimg.cc/dZ15PfSs)
|
||
------
|
||
|
||
kiftd能够帮助您快速搭建起一个面向家庭、团队或组织的网盘系统，它操作简单、高效且功能多样。这里是kiftd的源代码资源库，您可以在这里获得kiftd的源代码，并对其进行下载、阅读与重构。
|
||
|
||
注：如果您仅仅希望得到一份拿来即用的软件，kiftd也提供了一个完整的、解压即用的编译版。您可以根据其说明在3分钟内快速安装并开始使用。如果您需要该版本，请转到以下位置进行浏览和下载：
|
||
[kiftd-官方主页](https://kohgylw.github.io/)
|
||
|
||
|
||
### 构建说明
|
||
_下列条目为kiftd开发环境的基本信息，如需对源代码进行查看及编译，推荐使用所列配置。_
|
||
+ JDK版本：1.8.0
|
||
+ 项目管理框架：Maven（m2e 1.8.0 for Eclipse）,Archetype：mavem-archetype-quickstart 1.1。
|
||
+ 编码格式：UTF-8
|
||
+ 项目资源及配置：Spring Boot+MyBatis+H2 DB，详见pom.xml文档。
|
||
|
||
### 快速开始
|
||
+ 使用Eclipse(javaEE)以项目方式导入本资源文件夹，并设置构建路径中的JDK版本。
|
||
+ 使用Maven选项更新项目，并确保pom文件中引入的所有外部资源能够正确引入至本地。
|
||
+ 打开kohgylw.kiftd.mc.MC类，进行测试运行。
|
||
+ 右键项目，执行Run with选项中的Maven install操作以在target文件夹内编译生成jar程序。
|
||
+ 将生成的jar程序拷贝到项目主目录下（即与libs等文件夹同级）并开始使用。
|
||
|
||
_提示：源代码路径下包含了一些程序运行所需的非源代码资源（例如程序图标等），某些集成式开发环境（例如IDEA）在编译过程中可能会自动忽略非源代码资源。您需要设置并保证这些资源也能够被正确打包至最终的jar程序内，否则将会导致编译出的程序无法顺利运行。_
|
||
|
||
### 程序基本结构说明
|
||
+ 源代码资源文件夹：/src/main/java/
|
||
+ 入口类：kohgylw.kiftd.mc.MC
|
||
+ web界面请求处理包：kohgylw.kiftd.server.controller、kohgylw.kiftd.server.filter
|
||
+ web界面操作逻辑包：kohgylw.kiftd.server.service
|
||
+ 核心功能及文件系统实现包：kohgylw.server.util、kohgylw.kiftd.server.listener、kohgylw.kiftd.server.mapper、kohgylw.kiftd.server.model
|
||
+ 服务器行为控制类：kohgylw.server.ctl.KiftdCtl
|
||
+ 服务器界面相关包：kohgylw.kiftd.ui、kohgylw.kiftd.printer
|
||
+ 独立文件管理模块相关包：kohgylw.kiftd.util.file_system_manager
|
||
+ 第三方工具使用许可证包：kohgylw.kiftd.util.licenses
|
||
+ web页面静态资源文件夹：/webContext/
|
||
+ mybatis映射表文件夹：/mybatisResource/
|
||
+ 外部引用资源（编译后生成）文件夹：/libs/
|
||
+ 引用字体文件夹：/fonts/
|
||
+ 设置文件（程序第一次运行后生成）文件夹：/conf/
|
||
+ 日志文件夹：/logs/
|
||
+ 编译输出文件夹：/target/
|
||
+ maven配置文件：/pom.xml
|
||
|
||
### 常见问题&解决方案
|
||
+ 使用IDEA导入项目后无法以图形界面方式运行
|
||
> 在默认情况下，IDEA可能会自动忽略位于项目源代码路径内的所有非源代码文件，从而导致图形界面需要的某些图标文件（例如png文件）无法被识别和打包。如遇此问题，请修改IDEA设置，确保项目源代码路径下的所有文件均会被识别和打包。
|
||
|
||
+ 启动源代码项目时出现“Error creating bean with name org.mybatis.spring.mapper.MapperScannerConfigurer”
|
||
> 如遇该问题，请尝试将pom.xml文件中引入的`mybatis`资源和`mybatis-spring`资源移除并重新添加`mybatis-spring-boot-starter`资源，从而避免默认整合方式可能导致的Spring Boot框架插件兼容性问题（特别鸣谢：用户 michael）。
|
||
|
||
### 使用许可（下载该源代码资源即视为接受以下许可）
|
||
当前版本的kiftd使用自带的许可文件进行分发。您应该先阅读该文件（获取方式：前往kiftd发行版主页下载一份kiftd发行版并在其中获得，详见 https://github.com/KOHGYLW/kiftd ），并在同意其中的所有条款后再下载该源代码。其大致内容如下：
|
||
|
||
+ 您可以免费获得该源代码的原版拷贝。
|
||
+ 您可以自由地对该源代码进行分发、重构并运用于任何领域。
|
||
+ 作者对于使用该源代码造成的任何后果均无需负责。
|
||
+ 作者对该源代码具有版权。
|
||
|
||
### 关于该源代码...
|
||
该源代码为目前发布的kiftd解压即用版的原始编译来源，二者保持一致性（有时源码版本可能会略微超前），作者将在今后对其逐步进行整理以便于用户阅读，由此带来的不便敬请谅解。
|
||
|
||
### 联系作者？
|
||
如有任何需要（例如对该资源有疑问、意见或建议），请发件联系作者： kohgylw@163.com （青阳龙野），随时恭候您的来信！
|
||
|
||
青阳龙野@kohgylw by 2024年07月20日
|
||
|