readme.md · 7hservice/oneDoc

One Doc基于SpringBoot + Vue3.0开发，提供Office等文档的在线预览服务。

## 效果图

![image-20210330164400100](images/img.png)
![image-20210330164400100](images/img_1.png)
![image-20210330164400100](images/img_2.png)

## 一、项目介绍

One Doc是一款基于SpringBoot + Vue3.0开发的在线文档预览系统，支持Office和PDF的在线预览、下载、打印等功能。
One Doc提供了一套完整的文档预览解决方案，支持格式包括doc/docx、xls/xlsx、ppt/pptx、pdf
，提供添加水印等功能，且为手机端预览提供了前端适配，可满足大部分在线文档预览的需求。

## 二、项目结构

```
├─one-doc
│  ├─src(one-doc-server 后端服务)
│  └─ui(one-doc-web 前端页面)
```

## 三、技术选型

### 3.1 后端技术

| 技术            | 说明         | 官网                                                                                                 |
|---------------|------------|----------------------------------------------------------------------------------------------------|
| Spring Boot   | 容器+MVC框架   | [https://spring.io/projects/spring-boot](https://spring.io/projects/spring-boot)                   |
| Gradle        | 项目构建管理     | [https://gradle.org/](https://gradle.org/)                                                         |
| Logback       | 日志框架       | [https://logback.qos.ch/](https://logback.qos.ch/)                                                 |
| thymeleaf     | 模板引擎       | [https://www.thymeleaf.org/](https://www.thymeleaf.org/)                                           |
| Kotlin        | 语言         | [https://kotlinlang.org/](https://kotlinlang.org/)                                                 |
| Kotoframework | 数据持久层ORM框架 | [https://kotoframework.com/](https://kotoframework.com/)                                           |
| Sqlite        | 数据库        | [https://www.sqlite.org/index.html](https://www.sqlite.org/index.html)                             |
| Apache POI    | Office文档解析 | [https://poi.apache.org/](https://poi.apache.org/)                                                 |
| PDFBox        | PDF文档解析    | [https://pdfbox.apache.org/](https://pdfbox.apache.org/)                                           |
| LibreOffice   | Office转PDF | [https://www.libreoffice.org/](https://www.libreoffice.org/)                                       |
| Jacob         | Office转PDF | [https://sourceforge.net/projects/jacob-project/](https://sourceforge.net/projects/jacob-project/) |

### 3.2 前端技术

| 技术          | 说明       | 官网                                                                     |
|-------------|----------|------------------------------------------------------------------------|
| Vue3.0      | 前端框架     | [https://v3.cn.vuejs.org/](https://v3.cn.vuejs.org/)                   |
| Arco        | 前端组件库    | [https://arco.design/](https://arco.design/)                           |
| Axios       | 前端HTTP框架 | [https://axios-js.com/](https://axios-js.com/)                         |
| Pinia       | 前端状态管理   | [https://pinia.esm.dev/](https://pinia.esm.dev/)                       |
| Vue Router  | 前端路由     | [https://next.router.vuejs.org/](https://next.router.vuejs.org/)       |
| Vite        | 前端构建工具   | [https://cn.vitejs.dev/](https://cn.vitejs.dev/)                       |
| pdfjs       | PDF预览    | [https://mozilla.github.io/pdf.js/](https://mozilla.github.io/pdf.js/) |
| print.js    | 打印       | [https://printjs.crabbly.com/](https://printjs.crabbly.com/)           |
| qs          | URL参数处理  | [https://github.com/ljharb/qs](https://github.com/ljharb/qs)           |
| animate.css | 动画       | [https://animate.style/](https://animate.style/)                       |

## 四、项目部署

### 4.1 环境准备

- JDK1.8+
- Node.js 12.0+
- NPM 6.0+
- Sqlite 3.0+
- Git
- IDE（推荐IDEA）
- Chrome浏览器
- 服务器（可选）
- Docker（可选）
- Nginx（可选）
- 证书（可选）
- 域名（可选）
- 服务器（可选）

### 4.2 项目下载

```
git clone https://gitee.com/leinbo/one-doc.git
```

### 4.3 后端服务部署

#### 4.3.1 后端服务编译

```
cd one-doc/src
gradlew build
```

#### 4.3.2 后端服务运行

```
java -jar build/libs/one-doc-1.0.0.jar
```

#### 4.3.3 后端服务配置

```
# 服务端口
server.port=8080
    
# 数据库文件路径
spring.datasource.url=jdbc:sqlite:sqlite/oneDoc.db

更多配置见Config表

```sql
create table config
(
    "id"                         integer,
    "download_path"              varchar(255), # 下载路径
    "allowed_extension"          varchar(255), # 允许的文件扩展名

# 以下为水印配置
    "watermark"                  varchar(255), # default null
    "watermark_font_color"       varchar(255), # default #000000
    "watermark_font_size"        double,       # default 25
    "watermark_opacity"          double,       # default 0.5
    "watermark_rotation"         double,       # default 30
    "watermark_vertical_align"   integer,      # default 2
    "watermark_horizontal_align" integer,      # default 2
    "watermark_font_style"       integer,      # default 0
    "watermark_repeat"           tinyint,      # default 0
    "watermark_margin_x"         double,       # default 20
    "watermark_margin_y"         double        # default 20
);

# watermark_horizontal_align：0:None, 1:Left, 2:Center, 3:Right, 4:Justify, 5:FullJustify

# watermark_vertical_align: 0:None, 1:Top, 2:Center, 3:Bottom

# watermark_font_style: 
# 0:Courier, 1:CourierBold, 2:CourierOblique, 3:CourierBoldOblique,
# 4:Helvetica, 5:HelveticaBold, 6:HelveticaOblique, 7:HelveticaBoldOblique,
# 8:Symbol, 9:TimesRoman, 10:TimesBold, 11:TimesItalic, 12:TimesBoldItalic,
# 13:ZapfDingbats, 14:Unknown, 15:CjkFont

```

### 4.4 前端服务部署

#### 4.4.1 前端服务编译

```
cd one-doc/src/main/resources/ui
npm install
npm run build
```

#### 4.4.2 前端服务运行

```
npm run dev
```

#### 4.4.3 前端服务配置

# 服务端口
VITE_PORT=4567

# 后端服务地址
VITE_API_URL=http://localhost:8080

#### 4.4.4 前端服务打包

```

npm run build

```

### 4.5 Docker部署

#### 4.5.1 Docker编译

```

cd one-doc
docker build -t one-doc .

```

#### 4.5.2 Docker运行

```

docker run -d -p 8080:8080 -p 4567:4567 --name one-doc one-doc

```

### 4.6 Nginx部署

#### 4.6.1 Nginx配置

```

server {
    listen 80;
    server_name one-doc.com;
    location / {
    proxy_pass http://localhost:4567;
    }
}

```

文件表结构

```sql
create table node
(
    "id"            integer,
    "node_url"      varchar(255),
    "node_md5"      varchar(255),
    "node_name"     varchar(255),
    "node_type"     varchar(255),
    "node_size"     double,
    "absolute_path" varchar(255),
    "pdf_path"      varchar(255),
    "cover"         varchar(255),
    "sheet_num"     integer,
    "sheet_names"   varchar(255),
    "htmls"         varchar(255),
    "status"        varchar(255),
    "create_time"   datetime,
    "update_time"   datetime
);

```

7hservice/oneDoc

简介

发行版

贡献者

近期动态

7hservice/oneDoc .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

7hservice/oneDoc