CSICIT国产化快速开发平台开发手册

一、开发环境

• 服务端开发语言: java、node.js
• java服务端开发框架: SpringBoot + MybatisPlus
• 前端开发框架:VUE
• 开发工具: Intellij IDEA(java服务端)、WebStorm(UI端、node服务端)
• 开发环境: Window10
• 部署容器: Docker
• 微服务框架: Spring Cloud + Nacos
• 消息框架: Socket.io
• java版本: 1.8
• java编译工具: Apache-maven（3.x）
• 关系型数据库: 达梦、Mysql、Oracle
• 缓存数据库: Redis

二、环境准备

2.1 JAVA1.8安装

安装配置参考 https://blog.csdn.net/weixin_45264625/article/details/92768169

2.2 Maven 3安装

安装配置参考 https://blog.csdn.net/weixin_45264625/article/details/92771548

2.3 NodeJs 安装

安装配置参考 https://www.cnblogs.com/zhouyu2017/p/6485265.html

2.4 IDEA 插件配置

2.4.1 引入插件

File–>Settings–>Plugins
在搜索框中输入需要用到的插件，点击install即可

2.4.2 平台目前在用插件

• lombok
• Free MyBatis plugin
• YAML

三、应用开发

3.1 JAVA服务端开发

3.1.1 平台提供文件

• pom.xml:基于平台开发所需jar包依赖
• application.yml:spring-boot配置文件，该文件提供参考，配置了数据库连接以及日志及spring涉及的相关配置，仅供参考使用
• bootstrap.yml:spring-boot配置文件，平台相关配置项
• logback-spring.xml:logback日志配置文件
• interface.jar: 平台公共接口包(包括工具包)
• dbplus.jar: 平台数据服务掉用包
• socket.io文件夹: 消息服务文件夹，包含了消息服务涉及的js文件
• webuploader文件夹: 附件上传文件夹，包含了附件上传涉及的js文件

3.1.2 快速开发平台开发步骤

1. 部署运行快速开发平台
2. 平台初始化配置及上传授权文件,授权文件会携带授权应用
3. 维护开发测试数据（建组织架构（集团-应用单元-部门-人员）->建用户->建3员用户->建应用
4. 通过所建应用拿到应用标识
5. 新建SpringBoot项目
6. 将interface.jar及dbplus.jar打入到本地maven仓库

a.将两个jar包加入添加至Maven本地仓库
  打开cmd窗口，定位到jar包所在文件路径，执行如下语句
    mvn install:install-file -Dfile=interface.jar  -DgroupId=cn.jari.ace 
    -DartifactId=interface -Dversion=1.0.0 -Dpackaging=jar
    
    mvn install:install-file -Dfile=dbplus.jar  -DgroupId=cn.jari.ace 
    -DartifactId=dbplus -Dversion=1.0.0 -Dpackaging=jar
  备注:单位有私库，直接将jar包上传至maven私库
b.添加jar包依赖
 <dependency>
   <groupId>cn.jari.ace</groupId>
   <artifactId>interface</artifactId>
   <version>1.0.0</version>
 </dependency>
 <dependency>
   <groupId>cn.jari.ace</groupId>
   <artifactId>dbplus</artifactId>
   <version>1.0.0</version>
 </dependency>

7. 修改pom依赖项，删除项目pom.xm文件中标签中的内容，将我们提供的pom.xml文件中标签中的内容复制到项目pom.xml文件的标签内
8. 拷入配置文件

 a) 在resources文件夹下拷入 bootstrap.yml,该文件中配置了项目的依托于平台的一些配置
 重点配置项
 ace.top.package.name  当前项目顶层包名
 ace.feign.url 网关地址 
 b) 修改application.properties文件为application.yml,配置当前应用的相关配置
 c) 在resources文件夹下拷入logback-spring.xml，该文件配置了日志相关配置信息，可以根据自己需求进行相关配置

9. SpringBoot启动类设置

a)在项目启动类上添加如下配置
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@EnableDiscoveryClient
@ComponentScan({"cn.jari.ace"})
@EnableFeignClients({"cn.jari.ace"})
@MapperScan({"cn.jari.ace.dbplus.mybatis.mapper"})
b)在ComponentScan配置中添加你的顶层包名,
比如@ComponentScan({"cn.jari.ace"，“com.bat.est”})
c)在EnableFeignClients配置中添加你的顶层包名,
比如@EnableFeignClients({"cn.jari.ace"，“com.bat.est”})
d)在MapperScan配置中添加你的mybatis数据处理层包名,
比如@MapperScan({"cn.jari.ace.dbplus.mybatis.mapper"，“com.bat.est.mapper”})

3.1.3 AceAuth注解使用配置

@AceAuth(value) 是人员调用权限的自定义主键，该注解注解类型为方法
加入该注解的方法在每次调用该方法前平台都会去查询该用户是否用户调用该方法的权限，有权限可以继续，无权限访问结束。
参数value值为该方法的功能描述
比如
@AceAuth("通过用户id获用户")
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public R get(@PathVariable("id") String id) {
User instance = userService.getById(id);
return R.ok().put("instance", instance);
}

3.1.4 消息推送服务前端配置

1. 在首页 （比如index.html页面中）引入相关js文件

<script type="text/javascript" src="<%= BASE_URL %>js/jquery-1.10.2.min.js"></script>
<script type="text/javascript" src="<%= BASE_URL %>js/socket.io.js"></script>
<script type="text/javascript" src="<%= BASE_URL %>js/public.js"></script>

2. 在登陆页调用 initSocketConnect（）方法

initSocketConnect(appId,callback)
appId : 应用id
callback ：回调函数，消息服务连接成功后回调函数

3.1.5 附件配置调用

1. 使用租户管理员创建文件存储库
   
   存储库类型可以选择文件、FTP或OSS，在日常使用中，一般创建的都是文件类型的存储库。
   
2. 创建附件配置项
   

上图中配置标识、数据源、关联表名均为必填字段，其他属性。

3. 在使用附件控件时，仅需要在组件中导入FileUploader组件即可。

import FileUploader from "../../common/components/uploader/FileUploader"
在要使用的位置添加如下标签：
<file-uploader ref="fileUploader" :configuration-key="configurationKey" :form-id="formId1" :allow-upload="allowUpload"
               :allow-download="allowDownload"/>
其中configuration-key和form-id为必填属性