README文档模板 含下载地址0积分 项目文档模板 springboot文档示例 readme参考文档 目录跳转 项目架构 使用说明 目录结构 等等 （含附件下载）

已于 2022-01-21 17:25:47 修改
阅读量1.1k 收藏 1
点赞数
分类专栏： 基础 文章标签： spring boot 后端 java
于 2022-01-17 11:09:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41808217/article/details/122535797
版权

下载地址0积分

项目名称

在线签约(signup) （v1.1.0）

目录

项目简介

*-signup项目（以下简称signup项目），是一个纯在线提供签约服务的项目
。也可以理解为是辅助签约的工具包，其中不包含数据库操作和消息队列操作，提供的是在线文件转换和签约接口整合的项目。目前签约方三方服务提供者为上上签（https://www.bestsign.cn/）

功能简述

此版本功能包含了提供的线上服务和项目的以下特色：

线上服务：

  • 格式转换：word2pdf、html2pdf、pdf2img、pdf2file还支持html2img、html2md等一系列格式转换服务；
  • 在线签约：集成大多上上签官网提供的api接口，简单配置开发者信息便可开箱使用。
  • 特别加强：pdf异步解析，静默签功能

项目特色

  • 双系统支持：支持window和linux作为服务器,对应插件位置放对就行；
  • 定时任务：支持多维度系统定时任务；
  • 鉴权：自定义filter过滤器；
  • 自定义业务异常：自定义业务异常；
  • 全局异常：全局异常处理器；
  • 全局响应格式：全局响应格式返回；
  • 唯一异常：全局异常封装处理，友好返回给前端，唯一编号查询系统日志，唯一编码可反编译出时间格式(由于swagger2apimodel冲突暂未生效)；
  • knife4j：knife4j在线文档；
  • 转发资源直访支持：例如上上签静态资源访问本需要token访问，继承后我们系统支持的直接访问；
  • pdf高清和缩略图的高效解决方案：首页访问和缓存访问的解决方案,分片异步解析图片；
  • 线程池的最佳实践：核心数自动是cpu核数，无需配置；
  • redis中央缓存服务：第一次解析的pdf图片集都在redis中，过期时间可配置；
  • 全局配置中心管理：更好管理配置；
  • 静默签友好支持实现：一键开启常见的企业的静默签署实现；
  • 内容校验器：本地对发送合同的内同做了常规性校验，校验项多大20多处。

可扩展的

  • 全局异常日志查询接口（唯一异常暂未开启，无法实现）

项目架构

springboot+redis+knife4j+scheduTask+pdfbox+aspose+plugs+businessAsync

目录结构 

├── Readme.md                                                                                                           // readme文档
├── pom                                                                                                                 // 依赖pom
├── src                                                                                                                 // src
│    └──main                                                                                                            // main  
│        ├── java                                                                                                       // java
│        │       └── a.b.c.signup                                                                           			// 代码主目录
│        │                       ├── advice                                                                             // 通知
│        │                       │       ├── GlobalExceptionAdvice                                                      // 全局异常通知
│        │                       │       └── RestReturnValueHandlerAdvice                                               // 全局响应通知
│        │                       ├── async                                                                              // 异步
│        │                       │     └── BusinessAsync                                                                // 业务异步
│        │                       ├── config                                                                             // 配置
│        │                       │      ├── configEntity                                                                // 配置实体类
│        │                       │      ├── BestSignConfig                                                              // 上上签配置类
│        │                       │      ├── CustomParamResolverConfigurer                                               // CustomParamResolverConfigurer
│        │                       │      ├── FrameworkConfig                                                             // 自定义鉴权配置
│        │                       │      ├── HttpSessionConfig                                                           // HttpSessionConfig
│        │                       │      ├── InterceptorConfig                                                           // InterceptorConfig
│        │                       │      ├── MvcConfigurer                                                               // MvcConfigurer
│        │                       │      ├── CommandExecutor                                                          	// CommandExecutor
│        │                       │      ├── RestReturnValueHandlerConfigurer                                            // 全局响应程序配置类
│        │                       │      ├── ScheduleConfig                                                              // ScheduleConfig
│        │                       │      ├── Swagger2Config                                                              // swagger2ui信息配置
│        │                       │      └── WebAppConfig                                                                // WebAppConfig
│        │                       ├── entity                                                                             // 实体类
│        │                       ├── enums                                                                              // 枚举
│        │                       ├── exception                                                                          // 异常
│        │                       │        └── BusinessException                                                         // 业务异常
│        │                       ├── filter                                                                             // 过滤器
│        │                       │      └── SignFilter                                                                  // 验签过滤器
│        │                       ├── interceptor                                                                        // 拦截器
│        │                       │       └── AllInterceptor                                                             // 总拦截器
│        │                       ├── listener                                                                           // 监听器
│        │                       │        └── ApplicationStartup                                                        // 服务启动监控 
│        │                       ├── model                                                                              // 模型
│        │                       │      ├── AjaxResult                                                                  // ajax返回模型
│        │                       │      └── ReturnInfo                                                                  // 全局响应模型
│        │                       ├── open                                                                               // 开放接口层
│        │                       ├── pool                                                                               // 池化
│        │                       │     └── TaskExecutor                                                                 // 本地任务池
│        │                       ├── resolver                                                                           // 整理
│        │                       ├── service                                                                            // 业务层
│        │                       ├── task                                                                               // 任务
│        │                       │    └── ScheduTask                                                                    // 计划任务/定时任务
│        │                       ├── util                                                                               // 工具
│        │                       └── SignupApp                                                                       // Application
│        └── resources                                                                                                  // 资源集   
│                ├── application.yml                                                                                    // 主配置文件
│                ├── *.properties                                                                                       // 各类环境配置文件
│                ├── *.yml                                                                                              // 各类环境配置文件
│                ├── license.xml                                                                                        // aspose服务验签的配置文件（word2pdf水印去除服务）
│                └── logback-spring.xml                                                                                 // 系统slf4j日志配置文件                
└──test                                                                                                                 // test

使用效果

安装说明

  • 环境：(open)jdk 8.0+
  • 说明（必要说明）:
  • 1.jdk要支持fx扩展,可在其jre/lib/ext查看是否有jfxrt.jar包支持，oracle jdk 本身对fx支持不友好，所以正常运行这个项目必须要有这个jar支持
  • 2.*********
  • 3.html2pdf,html2img功能使用的插件完成的，插件分为win和linux，也需要这些来配合功能完成
  • 4.在linux环境下要添加必须的相关字体库，比如重要的宋体simsum.tff

使用说明

参照安装说明，安装好相关环境组件和项目依赖后（最低JVM堆大小4G+），正常启动SignupApp.main即可

开发人员

  • AAA
  • BBB
  • CCC

版权信息

当前版本 v.1.1.0

当前版本内容

  • 格式转换：word2pdf、html2pdf、pdf2img、pdf2file还支持html2img、html2md等一系列
  • 在线签约：像上上签官网提供的api大多常用的我们内部都封装支持，像常用的发送合同，合同撤销，盖章等
  • 特别加强：pdf异步解析，静默签功能，内容校验器

更新日志

版本时间内容
v.1.0.02021.8.x基本在线服务支持（格式转换，在线签约，文件服务）
v.1.1.02021.9.x去除文件流操作和附件服务，添加redis中央缓存操作，异步解析pdf方案以及静默签
若光672
关注
专栏目录
springboot 建readme_README
weixin_39528697的博客
12-19 588
第一阶段 SpringBoot、JPA、Redis第一章 Java编程思想深度理论知识重点理论单纯interface可以统一方法调用，但是它不能统一对象实例化。面向对象主要做两件事情：实例化对象和调用方法(完成业务逻辑)。只有一段代码中没有new的出现，才能保持代码相对稳定，才能逐步实现OCP，实质是一段代码如果要保持稳定，就不应该负责对象的实例化。对象的实例化是不可能消除的。把对象实例化的过程，...
README文件模板-New.zip
05-24
内含小型项目和国际开源项目的README.md文件的模板，资源类型为.md文件，文件内容可根据需要自行更改。
readme模板
清欢
05-22 2806
系统名称 系统概要 功能实现 1. 模块1 功能1 未完成功能 2. 模块2 功能1 未完成功能 技术选型 后台技术选型 SpringBoot(Spring、SpringMVC) MyBatis Thymeleaf 前端技术选型 Bootstrap jQuery 开发环境 操作系统：Windows 10 编程语言: Java 8 开发工具: IDEA、Navicat、Gi...
推荐：打造卓越README的神器 —— EliasGcf 的 README 模板集合
最新发布
gitblog_00189的博客
08-29 745
推荐：打造卓越README的神器 —— EliasGcf 的 README 模板集合 readme-template???? Templates to create amazing README's项目地址:https://gitcode.com/gh_mirrors/readmete/readme-template 在软件开发的世界里，一个好的 README 文件犹如灯塔，引领着开发者们的方向。今...
推荐项目：Readme-Template - 创建专业README文件的理想模板
gitblog_00064的博客
03-24 416
推荐项目：Readme-Template - 创建专业README文件的理想模板 去发现同类优质开源项目:https://gitcode.com/ 项目简介 是由开发者 dbader 创立的一个开源项目，旨在提供一系列高质量的 README 文件模板，帮助开发者和团队轻松创建出结构清晰、信息完整且具有专业感的项目说明文档。无论是个人小项目还是大型企业级应用，都能从中受益。 技术分析 该项目采用 M...
README 模板分享
qq_35860573的博客
01-20 988
Contact - 联系（其他联系信息（电子邮件地址，网站，公司名称，地址等）。提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍。提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍。Changelog - 更新日志（一个简短的历史记录（更改，替换或者其他）。License - 版权信息（版权和许可信息（或阅读许可证）、法律声明。其他联系信息（电子邮件地址，网站，公司名称，地址等）一个简短的历史记录（更改，替换或者其他）
推荐开源项目：一个好的README模板 - `a-good-readme-template`
gitblog_00069的博客
04-20 464
推荐开源项目：一个好的README模板 - a-good-readme-template a-good-readme-templateA template to make good README.md项目地址:https://gitcode.com/gh_mirrors/ag/a-good-readme-template 在软件开发中，一份清晰、简洁且信息丰富的README文件是项目质量的重要标...
Vue.js示例项目·简易留言板。本项目拥有完善的文档说明与注释，让您快速上手Vue.js开发SPA。.zip
10-21
- **README.md**：项目说明文档，通常包含项目介绍、安装步骤、运行方法等内容，对于初学者来说非常重要，因为它们指导着如何启动和使用项目。 - **src** 文件夹：这是项目的主要源代码目录，包含以下部分： - **...
java将markdown文档转换成html，生成左侧目录
11-04
项目的readme文件通常包含详细的安装、配置和使用指南，可能还会涉及依赖库的版本、命令行接口的参数、示例输入输出等。阅读readme文件对理解如何运行和定制这个工具至关重要。 在实际应用中，这个工具不仅可以用于...
基于Springboot+Vue月度员工绩效考核管理系统源码案例设计带文档说明.zip
04-21
项目通常包含详细的README文件或文档，解释系统的安装步骤、运行环境、配置信息、功能模块以及使用示例，帮助用户快速理解和部署系统。 综上所述，这个系统结合了Spring Boot的强大后端能力和Vue.js的高效前端渲染...
云E办Springboot+vue——前端项目完整版（含源码）
热门推荐
涵盖了计算机专业基础知识、数学建模相关实践、复杂网络论文研究、LeetCode算法刷题经验、C语言开发经验、前端Vue、React框架开发实战相关知识
08-10 5万+
本项目基于Vue+Spring Boot构架一个前后端分离项目。前端使用社区非常活跃的开源框架vue进行构建。受疫情的影响，许多企业由线上办公转为线下办公。随着线上办公的人数的增多，线上办公的优点逐步凸显：通过实现工作流程的自动化、节省企业办公费用、实现绿色办公，同时提升办公效率。前端使用的技术有： Vue、Vue-cli、Vuex、VueRouter、ElementUI、Axios、ES6、Webpack、WebSocket、font-awesome、js-file-download、vue-chat 项
README.txt
05-14
package selenium; import org.junit.Before; import org.junit.Test; import org.openqa.selenium.By; import org.openqa.selenium.WebDriver; import org.openqa.selenium.WebElement; import org.openqa.selenium.htmlunit.HtmlUnitDriver; import static junit.framework.Assert.assertNotNull; public class WebDriverTest { private WebDriver page; @Before public void before() { page = new HtmlUnitDriver(); } @Test public void testHasAnImageSearchPage() throws Exception { page.get("http://www.google.cn"); WebElement searchBox = page.findElement(By.name("q")); searchBox.sendKeys("JavaEye"); WebElement subBtn = page.findElement(By.name("btnG")); subBtn.submit(); WebElement result = page.findElement(By.linkText("http://www.javaeye.com")); assertNotNull(result); } }
Best-README-Template：一个很棒的README模板，可用于快速启动您的项目！
02-12
最佳自述模板 一个很棒的README模板，可以快速启动您的项目！ ·· 目录 关于该项目 GitHub上有很多很棒的README模板，但是我找不到真正适合我需要的模板，因此我创建了这个增强的模板。 我想创建一个自述模板，如此出色，以至于它将成为您需要的最后一个模板-我想就是这样。 原因如下： 您的时间应该集中在创造惊人的事物上。 一个解决问题并帮助他人的项目 您不应该一遍又一遍地执行相同的任务，就像从头开始创建自述文件一样 您应该将DRY原则纳入您的余生 :grinning_face_with_smiling_eyes: 当然，由于您的需求可能不同，因此没有一个模板可以为所有项目提供服务。 因此，我将在不久的将来添加更多内容。 您也可以通过分叉此存储库并创建请求请求或打开问题来提出更改建议。 感谢所有人为扩展此模板做出了贡献！ 确认中列出了一些我认为有用的常用资源。 建于 本节应列出您用来构建项目的所有主要框架。 将所有附件/插件留在“确认
springboot readme参考文档 带链接跳转
01-21
springboot readme参考文档 带链接跳转
README.md文件
07-12
这是一个用于微信小程序开发的md文件，希望可以帮助大家。
readme:自述模板
03-07
自述文件 gotemplate的自述文件生成器示例。 该项目是我们自述文件综合示例的一部分。 :page_facing_up: 执照 MIT是根据的开源软件。 用法 :page_facing_up: 例子 常见的 --- # name of this project name : readme # License of this project license : ' MIT ' copyright : name : Hadenlabs url : https://hadenlabs.com email : support : support@hadenlabs.com # Canonical GitHub repo github_repo : hadenlabs/readme # Badges to display badges : - name : ' Buil
README模板（附带英文）
weixin_34112030的博客
03-04 3193
以下参考了比较好的项目的readme，大家可以直接复制拿去用，节省时间~如果喜欢赏个star~ English | 简体中文 ZARA - 下一代前端框架（主标题） 基于 Web Components 并支持 IE8（简单介绍） 目录 生态 必须收藏的资源 快速入门 安装 用法 贡献者们 维护者 感谢 License 生态 → 生态学习路线图 项...
[模板] ReadMe 模板样例
攻城狮之路，互勉以修远...
11-25 1417
XXX ReadMe.md 1.XXX 说明 XXX是用于XXX（定位/功能） 其主要功能为XXX 2.XXX 安装运行要求 (1)运行前提条件 List item (2)项目运行步骤 List item List item 3.XXX 开发要求 List item 4.XXX 操作说明 (此处引入操作手册地址) 5.XXX 代码结构说明 ├── Readme.md ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

若光672

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值