How zfile-dev/zfile works
ZFile is a personal and small-team web drive that unifies multiple storage backends. The main workflow is browsing or operating on files through storage-source endpoints, which resolve a configured source to its backend service and return file results; account-specific roots and permissions scope access. The repository also includes administration, previews, sharing, direct/short links, and authentication/configuration features. Relationships beyond the sampled storage implementation are shown as unverified where only the tree or README establishes the capability.
Main entry points: StorageSourceContext.java Backend dispatch · StorageSourceService.java Source lifecycle · UserStorageSourceService.java Source permissions · FileController.java File endpoints
Components 25
Storage and files
- File endpoints
src/main/java/im/zhaojun/zfile/module/storage/controller/file/FileController.java - File operations
src/main/java/im/zhaojun/zfile/module/storage/controller/file/FileOperatorController.java - Backend dispatch
src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java - Storage adapters
src/main/java/im/zhaojun/zfile/module/storage/service/base/AbstractBaseFileService.java - Source management
src/main/java/im/zhaojun/zfile/module/storage/controller/base/StorageSourceController.java - Source metadata
src/main/java/im/zhaojun/zfile/module/storage/controller/base/StorageMetaDataController.java - Source lifecycle
src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java - Source records
src/main/java/im/zhaojun/zfile/module/storage/model/entity/StorageSource.java
Accounts and access
- User accounts
src/main/java/im/zhaojun/zfile/module/user/service/UserService.java - User endpoints
src/main/java/im/zhaojun/zfile/module/user/controller/UserController.java - Source permissions
src/main/java/im/zhaojun/zfile/module/user/service/UserStorageSourceService.java - Permission rules
src/main/java/im/zhaojun/zfile/module/permission/controller/StorageSourcePermissionController.java - File filters
src/main/java/im/zhaojun/zfile/module/filter/controller/StorageSourceFilterController.java
Sharing and links
- Share links
src/main/java/im/zhaojun/zfile/module/share/service/ShareLinkService.java - Shared file access
src/main/java/im/zhaojun/zfile/module/share/service/ShareLinkFileService.java - Direct and short links
src/main/java/im/zhaojun/zfile/module/link/controller/DirectLinkController.java - Short-link service
src/main/java/im/zhaojun/zfile/module/link/service/ShortLinkService.java
Administration
- Site settings
src/main/java/im/zhaojun/zfile/module/config/controller/SettingController.java - Configuration
src/main/java/im/zhaojun/zfile/module/config/service/SystemConfigService.java - Initial setup
src/main/java/im/zhaojun/zfile/module/install/controller/InstallController.java - Single sign-on
src/main/java/im/zhaojun/zfile/module/sso/service/SsoService.java
Preview and integrations
- Folder readmes
src/main/java/im/zhaojun/zfile/module/readme/controller/StorageSourceReadmeController.java - Office preview
src/main/java/im/zhaojun/zfile/module/onlyoffice/controller/OnlyOfficeController.java
Other components
- Drive user
- Configured storage
Connections 26
- Drive user → File endpoints: browses files
README.md - File endpoints → Backend dispatch: resolves backend
- File operations → Backend dispatch: dispatches operations
- Backend dispatch → Storage adapters: selects service
src/main/java/im/zhaojun/zfile/module/storage/context/StorageSourceContext.java - Storage adapters → Configured storage: accesses files
README.md - Drive user → File operations: operates files
README.md - Source management → Source lifecycle: manages sources
src/main/java/im/zhaojun/zfile/module/storage/controller/base/StorageSourceController.java - Source metadata → Backend dispatch: gets source fields
src/main/java/im/zhaojun/zfile/module/storage/controller/base/StorageMetaDataController.java - Source lifecycle → Backend dispatch: initializes sources
src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java - Source lifecycle → Source records: persists sources
src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java - User endpoints → User accounts: manages accounts
- Drive user → User endpoints: signs in
- Source permissions → User accounts: scopes source access
src/main/java/im/zhaojun/zfile/module/user/service/UserStorageSourceService.java - Source permissions → Source lifecycle: grants defaults
src/main/java/im/zhaojun/zfile/module/storage/service/StorageSourceService.java - Permission rules → Source permissions: configures permissions
src/main/java/im/zhaojun/zfile/module/permission/controller/StorageSourcePermissionController.java - File filters → Drive user: configures file limits
README.md - Drive user → Share links: creates share
README.md - Share links → Shared file access: serves shared files
- Drive user → Direct and short links: requests file link
README.md - Direct and short links → Short-link service: resolves short links
- Drive user → Site settings: updates site
- Site settings → Configuration: saves settings
- Initial setup → Configuration: initializes setup
- Drive user → Single sign-on: authenticates
- Drive user → Folder readmes: views folder notes
- Drive user → Office preview: previews documents
README.md