Alfresco-Vue

# 指南

# 介绍

# 简介

Alfresco-Vue 是ECM（企业内容管理）低代码开发平台，目标是为开发中大型文档管理项目提供开箱即用的解决方案。平台包含前端和后端两个部分：

  1. 前端基于Vue3.0、Vite、Ant-Design-Vue、TypeScript、Pinia等最新前端技术， 包括二次封装组件、utils、hooks、动态菜单、权限校验等功能，并整合和许多与alfresco相关的功能模块。该项目会持续跟进最新技术，并将其应用在项目中。
  2. 后端基于Alfresco，Alfresco是全球最大的开源ECM提供商，是面向企业级应用的开源的内容管理系统，是目前应用最广泛的开源企业知识管理系统，InfoWorld最佳开源软件，同时结合开源方式的创造性和企业级平台的稳定性的特点。

# 项目预览

Alfresco-Vue最新版 (opens new window)

# 文档

本文档需商用授权，仅限获取授权的用户使用。请在公司内部使用，勿对外公开。

# 本地运行文档

本文档采用采用 Vitepress 开发，如需本地运行该帮助文档，请拉取代码到本地。

# 安装依赖
yarn

# 运行项目
yarn dev

# 需要掌握的基础知识

本项目需要一定前后端基础知识，请确保掌握Java和Vue的基础知识，以便能处理一些常见的问题。 建议在开发前先学一下以下内容，提前了解和学习这些知识，会对项目理解非常有帮助:

  1. 前端
  2. 后端

# 浏览器支持

本地开发推荐使用Chrome 最新版浏览器，不支持Chrome 80以下版本。

生产环境支持现代浏览器，不支持 IE。

IE Edge Firefox Chrome Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

# 开始

说明

接下来将按从前端到后端的顺序，介绍如何快速启动项目。

开发环境的后端项目部署有两种方式：

1、使用Docker形式部署在本地（项目内置模块），此时对本地硬件要求比较高，建议在内存16G以上的情况下可采用此方式。

2、部署在单独的开发服务器上。

本指南采用第1种方式，而实际开发中建议采用第2种方式，有关第2种方式请参考：Alfresco SDK。

# 前端项目ADF-VUE

# 环境准备

本地环境需要安装 pnpm (opens new window)、Node.js (opens new window) 和 Git (opens new window)

注意

# 工具配置

如果您使用的 IDE 是vscode (opens new window)(推荐)的话，可以安装以下工具来提高开发效率及代码格式化

# 代码获取

注意

注意存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格，否则安装依赖后启动会出错。

# 安装

# 安装 Node.js

如果您电脑未安装Node.js (opens new window)，请安装它。

验证

# 出现相应npm版本即可
npm -v
# 出现相应node版本即可
node -v

如果你需要同时存在多个 node 版本，可以使用 Nvm (opens new window) 或者其他工具进行 Node.js 进行版本管理。

# 安装依赖

# pnpm 安装

必须使用 pnpm (opens new window)进行依赖安装（若其他包管理器安装不了需要自行处理）。

如果未安装pnpm，可以用下面命令来进行全局安装

# 全局安装yarn
npm install -g pnpm
# 验证
pnpm -v # 出现对应版本号即代表安装成功
# 依赖安装命令

在项目根目录下，打开命令窗口执行，耐心等待安装完成即可

# 安装依赖
pnpm i

# imagemin 依赖安装失败解决方法

由于 imagemin 在国内安装困难，提供以下几个解决方案：

  1. 使用 yarn 在 package.json 内配置(推荐，项目内已集成，前提是必须使用 yarn)
"resolutions": {
  "bin-wrapper": "npm:bin-wrapper-china"
}
  1. 使用 npm，在电脑 host 文件加上如下配置即可
199.232.4.133 raw.githubusercontent.com

安装依赖时 husky 安装失败

请查看你的源码是否从 git 直接下载的，直接下载是没有 .git 文件夹的，而 husky 需要依赖 git 才能安装。此时需使用 git init 初始化项目，再尝试重新安装即可。

# 配置

开发环境时候，接口地址在项目根目录下

.env.development 文件配置

# vite 本地跨域代理
VITE_PROXY=[["/proxy/alfresco","http://127.0.0.1:8080/alfresco/service"]]
# 接口地址
VITE_GLOB_API_URL=/proxy/alfresco
# 文件上传地址
VITE_GLOB_UPLOAD_URL=/proxy/alfresco

TIP

  • .env 文件中的字段如果是字符串，则无需加引号，默认全部为字符串
  • VITE_PROXY 不能换行

# 启动项目

pnpm serve

# 后端项目ADF-Extension

TIP

Alfresco扩展工程采用适配于Alfresco Community 7.2的Alfresco SDK 4.4进行二次开发

关于ADF-Extension的二次开发详见：Alfresco SDK

Alfresco SDK 4.4官方文档 (opens new window)

文中的路径、IP地址等均为演示数据，开发时请根据实际情况修改

# 配置开发环境

  • Java Development Kit (JDK) - Version 11 (OpenJDK)
  • Maven - Version 3.3+
  • Docker - Latest stable version

# java

  1. 下载JDK 11 (opens new window)，解压缩并配置好Java环境。
  2. 验证
     $ javac -version
 javac 11.0.1

 $ java -version
 openjdk version "11.0.1" 2018-10-16
 OpenJDK Runtime Environment 18.9 (build 11.0.1+13)
 OpenJDK 64-Bit Server VM 18.9 (build 11.0.1+13, mixed mode)

# Maven

Alfresco SDK 4.4 需要 Maven 3.3.0+，但建议您下载最新版本。

  1. 下载并安装Apache Maven (opens new window)并配置好的环境。
  2. 验证安装。
    $ mvn -v
Apache Maven 3.6.1 (d66c9c0b3152b2e69ee9bac180bb8fcc8e6af555; 2019-04-05T03:00:29+08:00)
Maven home: D:\Maven\apache-maven-3.6.1\bin\..
Java version: 11.0.2, vendor: Oracle Corporation, runtime: D:\Program Files\Java\openjdk\jdk-11.0.2
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Maven的配置文件settings.xml

settings.xml 文件一般存在于两个位置：

  • 全局配置： ${maven.home}/conf/settings.xml
  • 用户配置： ${user.home}/.m2/settings.xml

注意：用户配置优先于全局配置：

  • 配置优先级：局部配置优先于全局配置。
  • 配置优先级从高到低：pom.xml > user settings > global settings

如果这些文件同时存在，在应用配置时，会合并它们的内容，如果有重复的配置，优先级高的配置会覆盖优先级低的。如果有修改settings.xml请注意。

# Docker

  1. 下载并安装Docker (opens new window)。
  2. 验证 Docker 的安装。
    $ docker -v
Docker version 20.10.11, build dea9396
  3. Docker Compose (opens new window)包含在一些 Docker 安装程序中。如果它不是您安装的一部分，请在安装 Docker 后单独安装它。 （Windows环境安装的Docker中已包含Docker Compose）
  4. 验证 Docker Compose 的安装。
    $ docker-compose -v
docker-compose version 1.29.2, build 5becea4c

# 常见错误

  1. Windows环境启动 WSL 2时警告“参考的对象类型不支持尝试的操作”，解决方法： 管理员方式执行cmd命令
    netsh winsock reset
  2. Windows环境下，VMWare与Docker会有冲突，可通过以下方式来切换：

    注意：切换后重启电脑

    • 使用docker的时候：
    1. 命令行输入：bcdedit /set hypervisorlaunchtype auto
    2. 控制面板\所有控制面板项\网络连接 启用 vEthernet
    • 使用VMWare的时候：
    1. 命令行输入：bcdedit /set hypervisorlaunchtype off
    2. 控制面板\所有控制面板项\网络连接 禁用 vEthernet

# 代码获取

注意

注意存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格。

# 编译启动

.\run.bat build_start

说明

停止的脚本为

.\run.bat stop

# 执行初始化脚本

浏览器输入：http://localhost:8080/alfresco/service/idoc/setup/sysini

输入alfresco管理员账号（admin）与密码，点击确定

页面显示success，初始化脚本运行成功

# 完成

至此，项目安装完成。

在浏览器输入：http://localhost:3100/ 访问系统。

注意

系统在线编辑依赖于第三方产品onlyoffice，由于还未安装，在线编辑功能暂不可用。

onlyoffice的安装和配置将在后续章节中进行说明。

更新时间: 2023年3月10日星期五下午2点12分