1 Star 0 Fork 0

Simple李 / fs-turbo

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

FS-Turbo

介绍

FS-Turbo, Java web简单、快速、高性能附件解决方案 FS-Turbo, Simple, fast and high-performance attachment solution for Java web

功能

  • 提供文件上传下载,图片上传、缩略图生成、下载、预览接口
    • 提供基于Restful WEB API的
    • 提供基于Spring Component的Service接口
  • 不仅仅是Java语言,也可以作为通用的文件服务端使用

API清单

  1. 上传 POST /upload
  • 参数 form-data: sences busId file multi
    • sences: 场景,可不传入,不传入则默认为default。用户自行进行定义,一般使用所属业务简称
    • busId: 业务id,可不传入
    • file: 文件,必须传入
    • multi: 是否多文件,默认为false,可不传入,必须配套busId使用,为true表示对应的busId可以上传多个文件,为false则进行覆盖上传
  • 返回 json: code id message
    • code: 200表示成功
    • id: 文件服务生成唯一id,objectId类型,26位
    • message: 如果失败则返回错误消息
  1. 删除 POST /del
  • 参数 json payload: id
    • id: 文件id
  • 返回 json: code id message
    • code: 200表示成功
    • id: null
    • message: 如果失败则返回错误消息
  1. 下载 GET /download/{id}
  • 参数 path param: id
    • id: 文件id
  1. 预览 GET /preview/{id}
  • 参数 path param: id
    • id: 文件id
  1. 获取业务对应图片列表 /list/{sences}/{bus-id}
  • 参数 path param: sences bus-id
    • sences: 场景
    • bus-id: 业务id
  • 返回 array<string>,如存在则返回文件id数组,如不存在则返回空数组[]
  1. 图片上传 POST /image/upload 参数及返回同 /upload 接口
  2. 图片预览 GET /image/preview/{id}
  • 参数 path param: id
    • id: 图片id
  1. 缩略图预览 GET /image/thumb/{id}
  • 参数 path param: id
    • id: 图片id
  1. 根据业务预览图片 GET /image/preview/bus/{sences}/{bus-id}
  • 参数 path param: sences bus-id
    • sences: 场景
    • bus-id: 业务id

应用场景

  1. 一个业务id只有一个附件/图片
  • 可以采用两种设计模式:业务侵入性、业务无侵入性(建议)
    • 侵入性模式:在业务记录上增加一个字段用于存储附件id
    • 无侵入性模式:使用场景(sences)+业务id(bus-id)方式进行文件上传 但无侵入性模式存在缺陷:必须先存在业务id,对于新增场景有一定局限性 对于新增场景,业务侧不能设计为数据库自动生成id,而是点击新增后,新增界面从后台获取一个id作为业务id使用。
  • 业务数据删除,以下两种模式根据设计需求进行选择
    • 可以调用 /del 接口同步删除附件,也可以同步在业务侧集成fs-turbo,使用service进行事务性删除
    • 可以不删除附件,降低代码量和异常概率,但存在文件冗余
  1. 一个业务id有多个附件
  • 可以采用两种设计模式:业务侵入性、业务无侵入性(建议)
    • 侵入性模式:在业务记录上增加一个长字段用于存储多个附件id并使用分隔符如","隔开,或者增加明细关联表
    • 非侵入性模式:使用场景(sences)+业务id(bus-id)+多文件模式(multi)方式进行文件上传,新增场景同单附件。
      • 多图片预览:调用/list/{sences}/{bus-id}接口,返回id-list,通过/image/thumb/{id}/image/preview/{id}进行列表

部署/使用模式

嵌入式使用
<dependency>
    <groupId>cn.yhsoft</groupId>
    <artifactId>fs-turbo</artifactId>
    <version>${version}</version>
</dependency>
通用服务器(推荐)
准备工作
  1. git clone项目到本地
  2. 创建mysql数据库并通过create_table.sql创建所需数据库表
  3. 调整common-server配置文件适配器、数据库配置、WebContext信息
  • WebConfig.java 选择使用本地适配器或其他文件适配器,详见示例代码
  • application.properties
# 以下列举重要配置参数,其他参数详见文件注释
spring.datasource.url=jdbc:xxx
spring.datasource.username=root
spring.datasource.password=
#访问controller是的前缀,如配置为file则上传文件的地址为 /file/upload
fs-turbo.context=file
  1. build项目 mvn clean install
  2. 启动common-server java -jar fs-turbo-common-server-x.x.x.jar
使用

使用API详见[#### API清单] 以下仅说明基数使用模式,不包含集中鉴权

  1. 开发模式,配合vite、webpack等,在项目中配置反向代理,如下示例
proxy: {
    '/api/file': {
      target: 'http://127.0.0.1:8088',
      changeOrigin: true,
      rewrite: (path) => path.replace(/^\/api\/file/, '/file/')
    },
    '/api': {
      target: config.VITE_SERVICE_IP,
      changeOrigin: true,
      rewrite: (path) => path.replace(/^\/api/, '')
    }
}
  1. 部署模式,配合nginx使用,如下示例
location /api/file/ {
    proxy_pass http://127.0.0.1:8088/file/;
    proxy_http_version     1.1;
    proxy_set_header Upgrade                    $http_upgrade;
    proxy_set_header Host                       $host:$server_port;
    proxy_set_header X-Real-IP                  $remote_addr;
    proxy_set_header X-Forwarded-For    $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto  $scheme;
    proxy_set_header X-Forwarded-Host   $host;
    proxy_set_header X-Forwarded-Port   $server_port;
}
高性能部署模式

TODO

存储适配器

  1. 本地文件(默认)FsFileSystemStorageAdapter
  2. go-fastdfsGoFastDFSStorageAdapter
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

FS-Turbo, Java web简单、快速、高性能附件解决方案 Simple, fast and high-performance attachment solution for Java web 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/simple-lee/fs-turbo.git
git@gitee.com:simple-lee/fs-turbo.git
simple-lee
fs-turbo
fs-turbo
master

搜索帮助