技术文章

当前位置:首页>帮助手册>技术文章

Java全开源O2OA开发平台源码编译教程

时间:2022-03-22   

获取源码

O2OA是全开源的系统,完整的源码可以免费从gitee或者codechina获取。仓库地址是:

gitee: https://gitee.com/o2oa/O2OA.git

codechina: https://codechina.csdn.net/O2OA/o2oa.git


gitee仓库

我们打开gitee上的O2OA仓库,可以看到源码:(操作:浏览器打开项目仓库主页)

image - 2022-03-22T141204.131.pngimage - 2022-03-22T141204.131.png


展开分支:


image.png


我们来介绍一下几个主要有的分支:

develop

这是主分支,也是我们的开发分支,它有最新的源码,每天都会有大量的提交,最新的功能也会在此分支上。但它没有经过详细的测试,可能会有比较多的bug,适合希望了解O2OA最新更新和希望研究源码的用户,但不建议在生产环境使用它。

wrdp

基本上是develop分支的一个镜像,它与develop分支的更新基本保持一致

master

master分支是最新正式发布的O2OA稳定版源码,经过详细测试,编译后可在生产环境使用。

wrdp_java8

O2OA已经升级到java11版本,为了兼容希望坚持使用java8版本的用户,我们创建了此分支,它与develop分支的更新内容保持一致。如果希望O2OA功能保持最新,但又要使用java8的用户,可以使用此分支编译服务器。

master_java8

最后发布的java8稳定版,版本6.2.2。不再更新了,需要Java8版本的可以使用wrdp_java8分支。

如果你需要历史版本的源码,可以切换到对应的tag。(打开标签)

image (1).png

克隆源码

建议您先Fork源码到您自己的空间。

image (2).png


然后进入自己fork的仓库,复制克隆地址:

image (3).png


首先我们确保我们自己的机器上安装了git工具,如果没有的话:
windows系统可以到下面的地址下载:https://git-scm.com/download/win
centos使用命令:

Bash复制代码

1

yum install -y git


Ubuntu使用命令:

Bash复制代码

1

sudo apt-get install git


然后我们进入自己机器需要获取源码的目录,启动终端或使用git bash,输入以下命令clone源码:
git clonehttps://xxxxx
红色部分替换为你自己Fork的仓库地址。如:

Bash复制代码

1

git clone https://gitee.com/hq1980/O2OA.git


image (4).png

image (4).png


clone完成后,就可以看到O2OA的源码目录了。

image (5).png


编译源码

获取了源码后,我们就可以将源码编译为可运行的O2OA服务器了。

准备编译环境

在编译源码之前,我们需要准备编译环境,O2OA编译需要以下环境:

Node.js

编译脚本运行环境

jdk

根据您要编译的分支,决定使用jdk8 或者是 jdk11

maven

3.6及以上版本

上述环境安装,在此就不赘述了。

切换到要编译的分支

环境准备好后,我们打开终端或windows的命令行提示符,进入O2OA源码目录。默认情况先,现在是主分支,就是develop分支,如果我们需要编译其它分支,通过以下git命令切换,如切换到wrdp分支:

git checkout wrdp

image (6).png

image (6).png

编译
切换到您需要的分支后,需要先使用npm安装编译脚本所需要的依赖包,使用以下命令安装:(安装过程可能需要几分钟)

Bash复制代码

1

npm install


image (7).png

如果没有安装过gulp和jsdoc,需要先执行以下命令安装:

Bash复制代码

1

npm install -g gulp-cli
2

npm install -g jsdoc

然后就可以使用以下命令编译了:

Bash复制代码

1

npm run build_ci


image (8).png


整个编译过程大概需要30分钟。编译完成后,会在目录下生成target/o2server目录,这就是可运行的服务器目录。可以将它拷贝到服务器,运行相应start_xxx命令就可以运行O2OA了。这个等会编译完成后,我们再看。


优化编译

等待编译过程中,我们可以先介绍一下不同的编译命令,以及优化编译速度。

预先下载jvm和commons包

前面我们是使用build_ci命令编译的,它会自动下载jvm和一些依赖jar包(commons),这个过程会比较长,所以为了加快编译的速度,可以先手工下载jvm和依赖jar包。

依赖包下载:7.1之后的版本:https://download.o2oa.net/download/commons/7.2/commons.zip

                    7.0版本:https://download.o2oa.net/download/commons/7.0/commons.zip

6.4之后的版本:https://download.o2oa.net/download/commons/6.4/commons.zip

                    6.3.x及之前版本:https://download.o2oa.net/download/commons/commons.zip

下载解压后,将commons目录拷贝到o2server/目录下。

1578300247290-c1ee2c7d-8625-48c1-87bc-0283ca993a17.png


然后,需要下载对应的JVM

JVM 下载地址:

选择符合您的服务器操作系统环境的jvm进行下载,解压后放到o2server/jvm目录下,如果没有该目录请自行创建该目录。

然后我们就可以执行以下命令编译了:

npm run build

编译特定操作系统版本的O2OA

如果我们要编译指定操作系统版本的O2OA,可以使用以下命令:

方法一:没有下载JVM和依赖包commons

如果您没有手工下载JVM和依赖包commons,也没有关系,我们可以使用 “build_ci:xxx” 命令:

#编译windows版本
npm run build_ci:win

#编译linux x86版本
npm run build_ci:linux
                
#编译aix版本
npm run build_ci:aix

#编译linux arm版本
npm run build_ci:arm

#编译windows版本
npm run build_ci:macos

#编译linux mips版本
npm run build_ci:mips

#编译树莓派版本
npm run build_ci:rpi


方法二:已经下载了JVM和依赖包commons

如果已经手工下载了正确版本的JVM和依赖包commons,并放到的了o2server目录下,则使用 “build:xxx” 命令:

#编译windows版本
npm run build:win

#编译linux x86版本
npm run build:linux
                
#编译aix版本
npm run build:aix

#编译linux arm版本
npm run build:arm

#编译windows版本
npm run build:macos

#编译linux mips版本
npm run build:mips

#编译树莓派版本
npm run build:rpi

编译脚本功能清单

编译脚本的功能清单如下:

命令

运行

说明

build_ci

npm run build_ci

编译源码,自动下载JVM和依赖包,并构建可以运行在所有支持的操作系统的服务器。

build_ci:xxx

npm run build_ci:win

npm run build_ci:linux

npm run build_ci:aix

npm run build_ci:arm

npm run build_ci:macos

npm run build_ci:mips

npm run build_ci:rpi

编译源码,自动下载指定操作系统环境的JVM和依赖包,并构建可以运行在指定操作系统的服务器。

build

npm run build

预先下载JVM和依赖包,并放到o2server目录,

编译源码,构建可以运行在所有支持的操作系统的服务器。

build:xxx

npm run build:win

npm run build:linux

npm run build:aix

npm run build:arm

npm run build:macos

npm run build:mips

npm run build:rpi

预先下载JVM和依赖包,并放到o2server目录,

编译源码,构建可以运行在指定操作系统的服务器。

build_server

npm run build_server

单独编译O2OA服务端

build_web

npm run build_web

单独编译O2OA Web端

build_api

npm run build_api

生成O2OA脚本API文档


源码文件结构解析

趁服务器编译的过程,我们简单介绍一下源码文件结构。(打开gitee项目主页)

更目录下主要文件和目录:

o2android/

android端App源码,已经迁移到 https://gitee.com/o2oa/o2oa-android 仓库中

将在后续App编译课程中详细介绍

o2ios/

ios端App源码,已经迁移到 https://gitee.com/o2oa/o2oa-ios 仓库中

将在后续App编译课程中详细介绍

o2server/

服务端源码目录

o2web/

Web端源码目录

Jenkins*

Jenkins流水线文件,我们在持续发布流程中的流水线文件,

build.xml

maven打包文件

gulpfile.js

打包脚本文件

...

o2web目录结构说明

前端的源码都放置在o2web目录,其中代码部分都在o2web/source/目录下,其他一些是相关的配置和打包脚本文件,所以我们简单介绍一下o2web/source/目录的内容

o2_core/

O2OA前端的平台的核心代码,如一些用户认证相关,平台框架相关,服务请求相关的脚本代码。

o2_lib/

O2OA前端会引用到,或者可能会引用到的第三方框架或功能组件,如vue、mootools、ckeditor、echarts等

x_component_xxxxx

每个x_component开头的目录就是一个O2OA平台的一个应用,如:

x_component_Org-是组织管理应用;

x_component_portal_Portal - 是展现门户的应用;

x_component_process_TaskCenter - 是待办中心应用;

x_component_Meeting - 是会议管理应用;

……

o2_desktop

主要放置各种html文件,以及载入前端应用的loader脚本代码

o2server目录结构说明

configSample/

存放config的配置样例,在变异过程中会根据注解自动生成默认配置文件.

localSample/

存放local目录的配置文件,目前只有节点标识文件node.cfg.

x_console/

目录存放的是启动的主程序.

x_*_core_entity/

实体类项目.编译后打包成jar.

x_*_assemble_control

业务装配模块,最终向前端提供业务服务.

x_*_service_*/

后台服务模块,仅对其他模块提供服务,不向前端开放.

console_*.sh

控制台进入脚本.

restart_*.sh

服务器重启脚本

service_windows.bat

将服务器作为windows服务的生成脚本.

start_*.sh

服务器启动脚本.

stop_*.sh

服务器停止脚本.

此时服务器应该编译打包完成,打开源码的target/o2server目录展示,通过命令可以启动服务器:

windows系统运行:start_windows.bat

x86的linux系统运行: start_linux.sh

arm的linux系统运行: start_arm.sh

等等。





上一篇:OnlyOffice集成版O2OA服务器Docker镜像使用(O2OA+OnlyOffice容器化部署)

下一篇:How to start?