中文 / English

研发环境搭建

本文档讲解neatlogic-webroot(neatlogic-springboot)、neatlogic-runner、neatlogic-web 三个项目的研发环境搭建，neatlogic业务模块较多，请使用以下架构图理解各组件的部署方式和调用关系：

⭐ 其中页面后端可以通过两种方式启动

👉 neatlogic-webroot : 用于Tomcat9启动

👉 neatlogic-springboot : 用于SpringBoot启动

下载代码

获取代码签出neatlogic-itom-all可以一次性获取所有模块代码，由于neatlogic-itom-all使用submodule引入模块，签出代码时需加上--recurse-submodules参数。范例：

  git clone url --recurse-submodules

配置IntelliJ IDEA

❗ 注意：idea版本须大于 2022.2.4，低版本不支持Maven的profile功能，无法使用本项目

创建workspace

打开项目选择 neatlogic-webroot 模块打开再添加其他模块如上图,如果分支模块右侧的git分支号显示不是develop3.0.0则需要在neatlogic-itom-all目录下执行命令

git submodule foreach 'git checkout develop3.0.0'
#如果提示分支已存在，就先删除本地develop3.0.0分支
git branch -d develop3.0.0

配置maven

❗版本：须大于3.8，低版本的maven不支持profile功能，无法使用本项目

使用maven自带的setting.xml文件即可，如使用私有库请自行修改。

配置JDK

❗版本：JDK8

刷新maven依赖

profile仅需选择develop，代表当前进行开发分支代码的开发。由于目前项目不存在release分支，因此无需选择。commercial用于商业模块的开发，社区版用户无需选择。

❗ ❗ 如果提示找不到neatlogic-parent,就先install下neatlogic-parent这个模块后，重新执行上图“刷新maven依赖”操作

❕ 如果刷新后提示Could not find artifact 以下商业模块，则是正常的，执行后续步骤即可

启动配置

⭐ 其中页面后端可以通过两种方式启动，按需配置其中一种即可

👉 neatlogic-webroot : 用于Tomcat9启动

👉 neatlogic-springboot : 用于SpringBoot启动

使用Tomcat启动

❗版本：Tomcat9

配置启动参数

//nacos配置，会优先使用nacos，获取不到config则会从config.properties中获取
-Dnacos.home=192.168.0.10:8848 
-Dnacos.namespace=lvzk_local 
//日志级别
-Dlog4j.priority=ERROR 
//设为true，输入用户名后可使用任意密码登录，只能在研发阶段使用！
-DenableNoSecret=false
//确保JVM使用UTF-8编码来解释和处理文本数据,否则可能会导致中文乱码
-Dfile.encoding=UTF-8

配置deployment

配置context

配置自动构建的时机

配置config.properties

nacos的配置文件模板如下，如果不使用nacos，则需要配置在config.properties中：

#database properties
db.driverClassName = com.mysql.cj.jdbc.Driver
db.url = jdbc:mysql://localhost:3306/neatlogic?characterEncoding=UTF-8&jdbcCompliantTruncation=false&allowMultiQueries=true&useSSL=false&&serverTimeZone=Asia/Shanghai
db.username = root
db.password = password
db.dataSource.maxTotal=10
 
conn.validationQuery = select 1
conn.testOnBorrow = true
conn.maxActive = 50
conn.initialSize = 4
conn.maxIdle=16
#minio配置，如果不配置，默认使用本地存储
file.handler = MINIO
minio.url = http://localhost:8989
minio.bucket = neatlogic
minio.accesskey = minioadmin
minio.secretkey = minioadmin
#本地存储起始文件夹，如果调用minio失败，会自动转存到这里，如果需要多服务共享附件，此路径请配置到nas卷上。
data.home = /app/data

#自己的服务地址，主要用于内部跳转
home.url = http://localhost:8099/

#active MQ地址，没有可以不用配
jms.url = tcp://localhost:61616
#如果mq需要认证，则需要配置认证账号密码，否则无需配置
jms.user = neatlogic
jms.password = 123456

#心跳设置
heartbeat.rate = 3
heartbeat.threshold = 5

配置资源目录

将neatlogic-resources的localconfig目录定义为资源目录

使用SpringBoot启动

配置资源目录

将neatlogic-resources的localconfig目录定义为资源目录

设置启动参数

    //nacos配置，会优先使用nacos，获取不到config则会从config.properties中获取
    -Dnacos.home=192.168.0.10:8848
    -Dnacos.namespace=neatlogic
    //日志目录
    -Dlog4j.home=D:\logs2
    //日志级别
    -Dlog4j.priority=ERROR
    //设为true，输入用户名后可使用任意密码登录，只能在研发阶段使用！
    -DenableNoSecret=false
    //确保JVM使用UTF-8编码来解释和处理文本数据,否则可能会导致中文乱码
    -Dfile.encoding=UTF-8

创建数据库

数据库需使用Mysql8以上版本。neatlogic需要使用3个库，字符集采用utf8mb4，排序规则采用utf8mb4_general_ci，由于neatlogic需要动态创建、删除表和视图，请授予数据库连接用户适当的权限。

neatlogic：管理库，所用租户共用，用于管理租户信息（租户数据库配置信息等），管理系统的健康状态等。
neatlogic_xxx：xxx租户库，xxx租户的数据都保存在这个库。
neatlogic_xxx_data：xxx租户的扩展库，用于存放所有由系统自动生成的表和视图。人工构建时需要手动创建这个空库。

创建租户

以租户demo为例：

按照上述说明创建了3个空库neatlogic、neatlogic_demo和neatlogic_demo_data,如下图。
导入初始数据:neatlogic-database/mysql 将三个sql文件按名字分别导入到三个库。
修改neatlogic库的datasource表数据，修改tenant_uuid=demo行的相关字段。
修改neatlogic库的mongodb表数据，修改tenant_uuid=demo行的相关字段。
修改neatlogic库的elasticsearch表数据，修改tenant_uuid=demo行的相关字段。（如果没有部署es可以不用理会此表数据）。

部署完前端后可以使用账号:admin 密码:neatlogic@901 登录demo租户

变更租户

❗ 注意：此操作用于修改使用中的租户名称，如非必要，请勿操作

这里我们假设需要把demo换成uat租户。新建数据库neatlogic_uat和neatlogic_uat_data数据库，字符集同样是采用utf8mb4，排序规则采用utf8mb4_general_ci。
将neatlogic_demo表和数据同步到neatlogic_uat，neatlogic_demo_data只需要把表数据同步到neatlogic_uat_data，视图无需同步，可在系统中触发重建。
进入neatlogic库将tenant表、datasource表、mongodb表、elasticsearch表和tenant_modulegroup表中的“demo”字眼的数据都替换成“uat”。
重启tomcat即可。

创建MongoDB

❗ 注意：如不使用cmdb配置管理、自动化、巡检和发布模块等模块可以忽略以租户demo为例：

创建neatlogic_demo空库。
导入定义数据:neatlogic-database/mongodb ,通过mongostore导入即可。
修改 mysql 数据库中的neatlogic库的mongodb表,找到tenant_uuid=demo的那行数据，核对database、username、password、host和option是否正确配置。

启动服务

Tomcat9启动成功的日志示例：

SpringBoot启动成功的日志示例：

后端状态检查

浏览器访问 http://localhost:8080/neatlogic/tenant/check/demo

前端Vue项目搭建

安装node

❗ 版本：v18.x

英文网址：https://nodejs.org/en/download
中文网址：https://nodejs.cn/en/download

安装cnpm

❗ 版本：v8.2.0

npm install cnpm@8.2.0 -g --registry=https://registry.npm.taobao.org

如果启动时发现大量不明报错，可能原因是npm install阶段加载的依赖包不完整导致，可以对npm进行降级再次install，目前测试v18的npm可以正常install。或者通过cnpm install加载依赖包也可以。cnpm版本也不能太高，建议使用v8.2.0。建议使用nvm管理多版本的node，使用v18.x版本的node会比较稳定。

安装依赖

cnpm install

设置vscode

如希望加入本项目开发，推荐使用vscode，并使用我们的代码风格要求。

安装插件

EsLint、vetur、Prettier - Code formatter、i18nhelper(自动进行i18n键值替换和多语言翻译)

设置参数

设置>命令面板>输入“setting”>选择“首选项：打开设置”>打开 settings.json

{
   "gitlens.views.repositories.files.layout": "list",
    "git.confirmSync": false,
    "gitlens.advanced.similarityThreshold": null,
    "editor.tabSize": 2,
    "vetur.validation.script": true,
    "vetur.validation.style": true,
    "vetur.format.defaultFormatter.html": "js-beautify-html",
    "editor.formatOnSave": false,
    "vetur.format.defaultFormatterOptions": {
      "js-beautify-html": {
        "wrap_attributes": "auto",
        "indent_size": 2,
        "indent_char": " ",
        "indent_with_tabs": false,
        "eol": "\n",
        "end_with_newline": true,
        "preserve_newlines": true,
        "max-preserve-newlines": 3,
        "indent-inner-html": true,
        "wrap_line_length": 120,
        "editorconfig": true
      }
    },
    "html.format.maxPreserveNewLines": 3,
    "html.format.enable": false,
    "[vue]": {
      "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    },
    "[less]": {
      "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "gitlens.advanced.blame.customArguments": [],
    "[javascript]": {
      "editor.defaultFormatter": "vscode.typescript-language-features"
    },
    "[css]": {
      "editor.defaultFormatter": "HookyQR.beautify"
    },
    "[html]": {
      "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "javascript.updateImportsOnFileMove.enabled": "always",
  
      "[json]": {
      "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[git-commit]": {
      "editor.rulers": [
        72
      ],
      "workbench.editor.restoreViewState": false
    },
    "gitlens.advanced.messages": {},  
    "gitlens.gitCommands.closeOnFocusOut": true,
    "workbench.startupEditor": "newUntitledFile",
    "npm.enableRunFromFolder": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    },
    "editor.autoClosingBrackets":"always",
    "security.workspace.trust.untrustedFiles": "newWindow",
    "workbench.editorAssociations": {
      "*.html": "default"
    },
    "editor.unicodeHighlight.ambiguousCharacters": false,
    "diffEditor.ignoreTrimWhitespace": false,
    "eslint.alwaysShowStatus": true,
    "eslint.format.enable": true,
    "extensions.ignoreRecommendations": true,
    "npm.keybindingsChangedWarningShown": true,
    "settingsSync.ignoredSettings": [],
    "window.zoomLevel": 1,
    "typescript.disableAutomaticTypeAcquisition": true,
    "editor.suggest.snippetsPreventQuickSuggestions": false,
    "eslint.codeActionsOnSave.rules": null
}

修改启动配置

修改apiconfig.json配置文件，将tenantName的值修改为后端配置的租户（如果使用的是官方提供的用例数据，则租户就是demo），urlPrefix改成neatlogic后端tomcat服务的http://ip:port

启动项目

cnpm run serve

前端状态检查

浏览器访问 http://前端ip:前端port/demo #其中demo是租户（前端ip:前端port 可以从vscode的控制台日志获取）账号/密码： admin/neatlogic@901

如果前端控制台Compiled successfully 成功启动，访问还是异常

后端服务没有启动。浏览器访问http://后端ip:后端port/neatlogic/tenant/check/demo 是否正常返回。

前端项目的配置文件改错了（只需要按要求修改apiconfig文件，其它文件无需改动）。浏览器访问http://前端ip:前端port/demo/tenant/check 是否正常返回。确认前端服务是否正常启动。

防火墙没有开通（当然前后端浏览器都是localhost就排除这个原因）。到部署前端服务的服务器上请求后端http://后端ip:后端port/neatlogic/tenant/check/demo 是否正常返回。

其它

切换node版本

清理npm缓存：

npm cache clean -f

安装版本管理工具：

npm install -g n

升级到最新的版本：

n latest（最新版本）
n stable（最新稳定版本）

指定版本：

n 18.16.0

降低cnpm版本

卸载cnpm

npm uninstall -g cnpm

安装低版本的cnpm

npm install cnpm@8.2.0 -g --registry=https://registry.npm.taobao.org

其它常用的命令

##### 升级依赖包
cnpm update <package-name>

##### 查看已安装的包
cnpm list

neatlogic-runner项目搭建

（如果不涉及到CMDB采集、自动化、巡检相关功能此项目请忽略）

❗ 注意：由于neatlogic-runner使用了POSIX标准命令，仅支持mac或linux环境下研发

配置IntelliJ IDEA

确保下图中的“Add VM Option”和“Environment variables”被钩选上配置VM Option

//项目配置文件
-Dspring.config.location=/Users/cocokong/autoexec-runner/config/application.properties 
//启动类路径
-Xbootclasspath/a:/Users/cocokong/autoexec-runner/config/

配置环境变量

PATH 需加上 neatlogic-autoexec-backend项目的bin路径，否则执行作业会抛“找不到autoexec program”异常
如：/Users/cocokong/IdeaProjects/neatlogic-autoexec-backend/bin

配置文件

#SERVER
#应用名
spring.application.name=autoexecrunner
server.port=8084
server.servlet.context-path=/${spring.application.name}

# SPRING AOP CONFIG
spring.aop.auto=true
spring.aop.proxy-target-class=true

# UPLOAD FILE CONFIG
#上传限制
spring.servlet.multipart.enabled=true
spring.servlet.multipart.max-request-size=100MB
spring.servlet.multipart.max-file-size=100MB

#NEATLOGIC WEB
#neatlogic后端应用地址
neatlogic.root=http://127.0.0.1:8080/neatlogic
#认证 连接时校验
auth.type=basic
access.key=neatlogic
access.secret=x15wDEzSbBL6tV1W


#RUNNER
#runner根路径
runner.home=/Users/cocokong/autoexec-runner

#LOGGER
#日志级别
logging.config=${runner.home}/config/logback-spring.xml
logging.home=${runner.home}/logs/autoexec-runner
logging.level.root=DEBUG

#NEATLOGIC-AUTOEXEC-BACKEND
#neatlogic-autoexec-backend自动化作业数据路径
autoexec.home=/Users/cocokong/IdeaProjects/autoexec/data/job

#DEPLOY
#neatlogic--autoexec-backend发布版本数据路径
deploy.home=/app/autoexec/data/verdata
 
#neatlogic--autoexec-backend数据根路径
data.home=${runner.home}/data

#tagent 安装包下载目录，将文件放在这个目录，就可以通过“http://ip:8084/autoexecrunner/tagent/download/” +文件名下载文件
tagent.download.path=/app/autoexec/data/tagent/

引用neatlogic-tagent-client.jar

需添加neatlogic-tagent-client.jar到本地maven库或者私有的nexus仓库。导入jar到本地maven库

mvn install:install-file -Dfile=neatlogic-tagent-client.jar -DgroupId=com.neatlogic -DartifactId=tagent -Dversion=1.2.2.2 -Dpackaging=jar

pom.xml配置

<dependency>
	<groupId>com.neatlogic</groupId>
	<artifactId>tagent</artifactId>
	<version>1.2.2.2</version>
</dependency>

配置完毕启动即可，neatlogic-runner仅支持spring-boot方式启动。

清空出厂数据

❗ 注意：此操作用于清空出厂数据，方便用户从零开始配置，如非必要，请勿操作

清空数据库

以租户demo为例：

清空neatlogic_demo_data库中所有表和视图（结构和数据）
清空neatlogic库和neatlogic_demo中所有表的数据执行以下语句：重新写入demo租户的相关配置信息，请根据自身情况修改：

INSERT INTO `neatlogic`.`tenant` (`uuid`, `name`, `is_active`, `status`, `expire_date`, `description`, `error_msg`, `is_need_demo`, `visit_time`, `fcd`) VALUES ('demo', 'demo租户', 1, NULL, NULL, NULL, NULL, 0, NULL, NULL);

INSERT INTO `neatlogic`.`datasource` (`tenant_uuid`, `url`, `username`, `password`, `driver`, `host`, `port`) VALUES ('demo', 'jdbc:mysql://{host}:{port}/{dbname}?characterEncoding=UTF-8&jdbcCompliantTruncation=false&allowMultiQueries=true&useSSL=false&&serverTimeZone=Asia/Shanghai', 'root', 'password', 'com.mysql.cj.jdbc.Driver', 'localhost', 3306);

INSERT INTO `neatlogic`.`mongodb` (`tenant_uuid`, `database`, `username`, `password`, `host`, `option`, `auth_config`) VALUES ('demo', 'autoexec', 'autoexec', 'password', 'localhost', 'authSource=admin', NULL);

-- 以下语句用于配置租户可以使用哪些模块，请根据项目变化和自身需要添加

INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'autoexec');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'cmdb');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'dashboard');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'deploy');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'framework');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'inspect');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'knowledge');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'process');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'rdm');
INSERT INTO `neatlogic`.`tenant_modulegroup` (`tenant_uuid`, `module_group`) VALUES ('uat', 'report');

清空MongoDB

MongoDB库仅需保留下划线"_"开头的集合即可。

激活维护模式

由于所有数据已被清空，需要激活维护模式，使用维护账号登录。

1.修改JVM OPTION

-DenableMaintenance=true

2.修改config.properties或者nacos

maintenance=maintenance
maintenance.password=123456ab

重启tomcat，并确保服务正常启动使用 http://localhost:8080/neatlogic/tenant/check/uat 校验

首次访问

使用上面配置的maintenance用户登录系统。

账号：maintenance 密码：123456ab

登录后先完成用户、组、角色和权限的添加。完成后删除JVM OPTION和config文件相关配置禁用维护模式，再次重启后即可使用正常用户登录。

FAQ常见问题

前端项目 npm ERR! request to https://registry.npm.taobao.org/cnpm failed, reason: certificate has expired

npm config set strict-ssl false

乱码问题

先解决工具控制台编码问题，我们统一用UTF-8,然后按错误提示操作解决即可

Files

CODE-BUILD.md

Latest commit

History

CODE-BUILD.md

File metadata and controls

研发环境搭建

下载代码

配置IntelliJ IDEA

创建workspace

配置maven

配置JDK

刷新maven依赖

启动配置

使用Tomcat启动

配置启动参数

配置deployment

配置context

配置自动构建的时机

配置config.properties

配置资源目录

使用SpringBoot启动

配置资源目录

设置启动参数

创建数据库

创建租户

变更租户

创建MongoDB

启动服务

后端状态检查

前端Vue项目搭建

安装node

安装cnpm

安装依赖

设置vscode

安装插件

设置参数

修改启动配置

启动项目

前端状态检查

其它

切换node版本

降低cnpm版本

其它常用的命令

neatlogic-runner项目搭建

配置IntelliJ IDEA

配置文件

引用neatlogic-tagent-client.jar

清空出厂数据

清空数据库

清空MongoDB

激活维护模式

首次访问

FAQ常见问题

前端项目 npm ERR! request to https://registry.npm.taobao.org/cnpm failed, reason: certificate has expired

乱码问题