后端脚手架生成工程

后端脚手架生成工程

脚手架版本

  • 6.2.x(6.3.x/6.4.x)版本的脚手架,修改脚本(参考下节内容)中脚手架版本:

    # 新项目的pamirs platform version
    pamirsVersion=6.2.8
    ……
    # mvn archetype:generate执行片段中
    -DarchetypeVersion=6.2.8
  • 7.0.x版本的脚手架,修改脚本(参考下节内容)中脚手架版本:

    # 新项目的pamirs platform version
    pamirsVersion=7.0.5
    ……
    # mvn archetype:generate执行片段中
    -DarchetypeVersion=7.0.5 

后端脚手架生成工程

后端单工程脚手架

1、使用如下命令来用项目脚手架生成工程:新建archetype-project-generate.sh(bat) 脚本

  • archetype-project-generate.sh
#!/bin/bash

# 项目生成脚手架
# 用于新项目的构建

# 脚手架使用目录
# 本地 local
# 本地脚手架信息存储路径 ~/.m2/repository/archetype-catalog.xml
archetypeCatalog=local

# 以下参数以pamirs-demo为例

# 新项目的groupId
groupId=pro.shushi.pamirs.demo

# 新项目的artifactId
artifactId=pamirs-demo

# 新项目的version
version=1.0.0-SNAPSHOT

# Java包名前缀
packagePrefix=pro.shushi

# Java包名后缀
packageSuffix=pamirs.demo

# 新项目的pamirs platform version;根据上个章节中的版本介绍进行修改
pamirsVersion=6.2.8

# Java类名称前缀
javaClassNamePrefix=Demo

# 项目名称 module.displayName
projectName=OinoneDemo

# 模块 MODULE_MODULE 常量
moduleModule=demo_core

# 模块 MODULE_NAME 常量
moduleName=DemoCore

# spring.application.name
applicationName=pamirs-demo

# tomcat server address
serverAddress=0.0.0.0

# tomcat server port
serverPort=8090

# redis host
redisHost=127.0.0.1

# redis port
redisPort=6379

# 数据库名
db=demo

# zookeeper connect string
zkConnectString=127.0.0.1:2181

# zookeeper rootPath
zkRootPath=/demo

mvn archetype:generate \
  -DinteractiveMode=false \
  -DarchetypeCatalog=${archetypeCatalog} \
  -DarchetypeGroupId=pro.shushi.pamirs.archetype \
  -DarchetypeArtifactId=pamirs-project-archetype \
  -DarchetypeVersion=6.2.8 \  #根据上个章节中的版本介绍进行修改
  -DgroupId=${groupId} \
  -DartifactId=${artifactId} \
  -Dversion=${version} \
  -DpamirsVersion=${pamirsVersion} \
  -Dpackage=${packagePrefix}.${packageSuffix} \
  -DpackagePrefix=${packagePrefix} \
  -DpackageSuffix=${packageSuffix} \
  -DjavaClassNamePrefix=${javaClassNamePrefix} \
  -DprojectName="${projectName}" \
  -DmoduleModule=${moduleModule} \
  -DmoduleName=${moduleName} \
  -DapplicationName=${applicationName} \
  -DserverAddress=${serverAddress} \
  -DserverPort=${serverPort} \
  -DredisHost=${redisHost} \
  -DredisPort=${redisPort} \
  -Ddb=${db} \
  -DzkConnectString=${zkConnectString} \
  -DzkRootPath=${zkRootPath}
  • archetype-project-generate.bat
@echo off
:: 项目生成脚手架
set archetypeCatalog=local
set groupId=pro.shushi.pamirs.demo
set artifactId=pamirs-demo
set version=1.0.0-SNAPSHOT
set packagePrefix=pro.shushi
set packageSuffix=pamirs.demo
set pamirsVersion=6.2.8
set javaClassNamePrefix=Demo
set projectName=OinoneDemo
set moduleModule=demo_core
set moduleName=DemoCore
set applicationName=pamirs-demo
set serverAddress=0.0.0.0
set serverPort=8090
set redisHost=127.0.0.1
set redisPort=6379
set db=demo
set zkConnectString=127.0.0.1:2181
set zkRootPath=/demo

mvn archetype:generate ^
  -DinteractiveMode=false ^
  -DarchetypeCatalog=%archetypeCatalog% ^
  -DarchetypeGroupId=pro.shushi.pamirs.archetype ^
  -DarchetypeArtifactId=pamirs-project-archetype ^
  -DarchetypeVersion=%pamirsVersion% ^
  -DgroupId=%groupId% ^
  -DartifactId=%artifactId% ^
  -Dversion=%version% ^
  -DpamirsVersion=%pamirsVersion% ^
  -Dpackage=%packagePrefix%.%packageSuffix% ^
  -DpackagePrefix=%packagePrefix% ^
  -DpackageSuffix=%packageSuffix% ^
  -DjavaClassNamePrefix=%javaClassNamePrefix% ^
  -DprojectName="%projectName%" ^
  -DmoduleModule=%moduleModule% ^
  -DmoduleName=%moduleName% ^
  -DapplicationName=%applicationName% ^
  -DserverAddress=%serverAddress% ^
  -DserverPort=%serverPort% ^
  -DredisHost=%redisHost% ^
  -DredisPort=%redisPort% ^
  -Ddb=%db% ^
  -DzkConnectString=%zkConnectString% ^
  -DzkRootPath=%zkRootPath%

2、根据项目需求,根据脚本中的注释修改项目变量

3、确保Maven的settings文件是用的是数式发过去的对应的配置文件

4、Linux/Unix/Mac 需要执行以下命令添加执行权限; Windows下如果安装了git可以使用Git Bash执行Linux(sh)命令

chmod +x archetype-project-generate.sh

5、根据不同的操作系统执行脚手架命令
Linux/Unix/Mac/Windows(Git Bash):

 sh archetype-project-generate.sh 

Windows(CMD):

 archetype-project-generate.bat

6、执行完成后即可生成工程,生成的最终工程后根据实际情况进行一些修改

  • boot工程resources/static的index.html, 去掉前面3行多余的代码.( Velocity 模板变量问题导致)
    后端脚手架生成工程
  • 替换licence,包括licence文件和yml文件中licence的配置;
  • 替换yml文件中的OSS配置和中间件端口/地址/密码等;
  • 根据实际使用的版本情况,修改主pom中的版本号:
    <oinone-bom.version>7.0.5.1</oinone-bom.version>

    后端脚手架生成工程

后端多工程模块脚手架

1、使用如下命令来用项目脚手架生成模块工程:新建archetype-module-generate.sh(bat) 脚本

  • archetype-module-generate.sh
#!/bin/bash

# 模块生成脚手架
# 用于项目中构建新模块,注意: 该脚本应在项目根目录下执行

# 脚手架使用目录
# 本地 local
archetypeCatalog=local

# 以下参数以pamirs-demo为例

# 父项目的groupId
pamirsParentGroupId=pro.shushi.pamirs.demo

# 父项目的artifactId
pamirsParentArtifactId=pamirs-demo

# 父项目的version
pamirsParentVersion=1.0.0-SNAPSHOT

# 子项目的模块名
module=common

# 包名前缀
packagePrefix=pro.shushi

# 包名后缀
packageSuffix=pamirs.demo.common

# Java类名称前缀
javaClassNamePrefix=DemoCommon

# 项目名称
projectName=公共资源中心

# 模块 MODULE_MODULE 常量
moduleModule=demo_common

# 模块 MODULE_NAME 常量
moduleName=DemoCommon

# spring.application.name
applicationName=pamirs-demo-common

# tomcat server address
serverAddress=0.0.0.0

# tomcat server port
serverPort=8090

# 数据库名
db=demo

# zookeeper connect string
zkConnectString=127.0.0.1:2181

# zookeeper rootPath
zkRootPath=/demo

# redis host
redisHost=127.0.0.1

# redis port
redisPort=6379

mvn archetype:generate \
  -DinteractiveMode=false \
  -DarchetypeCatalog=${archetypeCatalog} \
  -DarchetypeGroupId=pro.shushi.pamirs.archetype.module \
  -DarchetypeArtifactId=pamirs-project-module-archetype \
  -DarchetypeVersion=7.0.5 \
  -DpamirsParentGroupId=${pamirsParentGroupId} \
  -DpamirsParentArtifactId=${pamirsParentArtifactId} \
  -DpamirsParentVersion=${pamirsParentVersion} \
  -DgroupId=${pamirsParentGroupId}.${module} \
  -DartifactId=${pamirsParentArtifactId}-${module} \
  -Dversion=${pamirsParentVersion} \
  -Dmodule=${module} \
  -Dpackage=${packagePrefix}.${packageSuffix} \
  -DpackagePrefix=${packagePrefix} \
  -DpackageSuffix=${packageSuffix} \
  -DjavaClassNamePrefix=${javaClassNamePrefix} \
  -DprojectName=${projectName} \
  -DmoduleModule=${moduleModule} \
  -DmoduleName=${moduleName} \
  -DapplicationName=${applicationName} \
  -DserverAddress=${serverAddress} \
  -DserverPort=${serverPort} \
  -Ddb=${db} \
  -DzkConnectString=${zkConnectString} \
  -DzkRootPath=${zkRootPath} \
  -DredisHost=${redisHost} \
  -DredisPort=${redisPort} \
  -Pshushi
  • archetype-module-generate.bat
@echo off
:: 模块生成脚手架
:: 用于项目中构建新模块,注意: 该脚本应在项目根目录下执行

:: 脚手架使用目录
:: 本地 local
set archetypeCatalog=local

:: 以下参数以kailas-libra-common为例

:: 父项目的groupId
set pamirsParentGroupId=pro.shushi.pamirs.demo

:: 父项目的artifactId
set pamirsParentArtifactId=pamirs-demo

:: 父项目的version
set pamirsParentVersion=1.0.0-SNAPSHOT

:: 子项目的模块名
set module=common

:: 包名前缀
set packagePrefix=pro.shushi

:: 包名后缀
set packageSuffix=pamirs.demo.common

:: Java类名称前缀
set javaClassNamePrefix=DemoCommon

:: 项目名称
set projectName=公共资源中心

:: 模块 MODULE_MODULE 常量
set moduleModule=demo_common

:: 模块 MODULE_NAME 常量
set moduleName=DemoCommon

:: spring.application.name
set applicationName=pamirs-demo-common

:: tomcat server address
set serverAddress=0.0.0.0

:: tomcat server port
set serverPort=8090

:: 数据库名
set db=demo

:: zookeeper connect string
set zkConnectString=127.0.0.1:2181

:: zookeeper rootPath
set zkRootPath=/demo

:: redis host
set redisHost=127.0.0.1

:: redis port
set redisPort=6379

mvn archetype:generate ^
  -DinteractiveMode=false ^
  -DarchetypeCatalog=%archetypeCatalog% ^
  -DarchetypeGroupId=pro.shushi.pamirs.archetype.module ^
  -DarchetypeArtifactId=pamirs-project-module-archetype ^
  -DarchetypeVersion=7.0.5 ^
  -DpamirsParentGroupId=%pamirsParentGroupId% ^
  -DpamirsParentArtifactId=%pamirsParentArtifactId% ^
  -DpamirsParentVersion=%pamirsParentVersion% ^
  -DgroupId=%pamirsParentGroupId%.%module% ^
  -DartifactId=%pamirsParentArtifactId%-%module% ^
  -Dversion=%pamirsParentVersion% ^
  -Dmodule=%module% ^
  -Dpackage=%packagePrefix%.%packageSuffix% ^
  -DpackagePrefix=%packagePrefix% ^
  -DpackageSuffix=%packageSuffix% ^
  -DjavaClassNamePrefix=%javaClassNamePrefix% ^
  -DprojectName=%projectName% ^
  -DmoduleModule=%moduleModule% ^
  -DmoduleName=%moduleName% ^
  -DapplicationName=%applicationName% ^
  -DserverAddress=%serverAddress% ^
  -DserverPort=%serverPort% ^
  -Ddb=%db% ^
  -DzkConnectString=%zkConnectString% ^
  -DzkRootPath=%zkRootPath% ^
  -DredisHost=%redisHost% ^
  -DredisPort=%redisPort% ^
  -Pshushi

2、后续脚本的执行请参考 后端单工程脚手架.

Oinone社区 作者:望闲原创文章,如若转载,请注明出处:https://doc.oinone.top/other/21573.html

访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验

(0)
望闲的头像望闲数式管理员
上一篇 2025年8月21日 pm2:13
下一篇 2025年8月26日 pm4:55

相关推荐

  • 前端发布接入jenkins

    最原始的前端发布,会经过本地打包、压个 zip 包、通过工具手动上传、找到 leader 帮忙解压到对应的服务器上、同步文件服务器等等的步骤。每一个环节都是人工操作,发个版非常的繁琐。接入jenkins有助于我们简化CI/CD流程,实现前端发布自动化。 1. jenkins 安装部署(docker) 1-1 前置条件 安装 git、docker、配置 ssh git 安装 # enter 到底 yum install -y git # 查看git版本号 验证git安装成功 # git version 1.8.3.1 git –version docker 安装 # docker-ce Docker社区版 # docker-ce-cli Docker命令行界面(CLI) # containerd.io Docker插件,直接调用 Docker Compose # docker-compose-plugin Docker插件,直接调用 Docker Compose yum install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin 配置 ssh # Enter到底,最终会生成以下文件 # /root/.ssh/authorized_keys 允许无密码登录的公钥列表 # /root/.ssh/id_rsa 私钥文件 # /root/.ssh/id_rsa.pub 公钥文件 注意该文件里的内容是接下来要用的 ssh-keygen -t rsa -C "root" # 复制公钥文件的内容,添加到GitHub 的 SSH keys 或 任意其他远程仓库 vim /root/.ssh/id_rsa.pub 1-2 jenkins 安装 docker 拉取镜像 # 拉取nginx docker pull nginx # 拉取jenkins docker pull jenkins/jenkins:lts # 查看镜像是否安装成功 docker images # REPOSITORY TAG IMAGE ID CREATED SIZE # jenkins/jenkins lts 6a44d1dd2d60 3 weeks ago 468MB # nginx latest 53a18edff809 7 weeks ago 192MB 创建 docker 相关目录 # 创建docker的相关目录 mkdir -p ./docker/{compose,jenkins_home,nginx/conf,html/origin/{master,dev}} # 创建docker-compose.yml配置文件 cd ./docker/compose # 具体配置内容见下面 touch docker-compose.yml # 创建nginx.conf配置文件 cd ./docker/nginx/conf # 具体配置内容见下面 touch nginx.conf 最终目录结构如下 ./docker/ ├── compose/ │ └── docker-compose.yml # 空的 docker-compose 配置文件 └── html/ └── origin/ ├── master/ # 预留的 master 版本 HTML 目录(为空) └── dev/ # 预留的 dev 版本 HTML…

    2025年5月12日
    60900
  • 外部系统接入SSO-OAuth2(6.3.x 之后版本支持)

    一、概述 统一身份认证系统提供了单点登录功能。本文档详述了统一身份认证系统单点登录接口,介绍了应用系统对接统一身份认证系统的过程和方法,用以帮助开发人员将应用系统接入统一身份认证系统。 本文档支持的协议:OAuth2 二、统一认证集成规范 2.1 SSO登录场景 序号 场景 预期结果 确认 1 登录跳转,在未登录的条件下,直接访问业务系统 跳转到单点登录界面 是 2 登录跳转,在已登录的条件下,直接访问业务系统 直接进入业务系统 是 3 正常登录,先登录认证,然后访问业务系统 直接进入业务系统 是 4 正常登出,在单点登录系统登出 访问业务系统要重新登录 是 5 正常登出,在业务系统登出 单点登录系统同步登出 是 2.2 认证流程 OAuth2 登录和认证流程 后端验证 token 后,创建本地会话(如 JSESSIONID 或自定义 Cookie); 后续应用请求靠本地会话维持登录状态,不再依赖原始 token; 本地会话有过期时间(如 30 分钟无操作过期); 三、认证服务接口 3.1 SSO服务端认证 浏览器登录 分类 说明 请求地址(开发环境) http://${host}:${port}/pamirs/sso/auth?client_id={client_id}&redirect_uri={redirect_uri}&state={state} 请求地址(测试环境) http://${host}:${port}/pamirs/sso/auth?client_id={client_id}&redirect_uri={redirect_uri}&state={state} 请求方式 GET 请求参数 redirect_uri:应用系统回调地址client_id:SSO 服务端颁发的应用 IDstate:可选但推荐,用于防止 CSRF 的随机字符串(UUID 随机码) 请求示例 http://${host}:${port}/pamirs/sso/auth?client_id=client123456&redirect_rui=http://app.example.com&state=abc123 响应说明 1. 已登录:重定向到 redirect 地址并携带授权码 code,如 http://app.example.com&state=abc123&code=xxx2. 未登录:重定向到服务器 SSO 登录地址 备注 SSO 登录成功后,会携带授权码并重定向到 redirect 地址 3.2 验证授权码 分类 说明 请求地址(开发环境) http://${host}:${port}/pamirs/sso/oauth2/authorize 请求地址(测试环境) http://${host}:${port}/pamirs/sso/oauth2/authorize 请求方式 POST 请求 Body {"grant_type":"authorization_code","client_id":"xxxx","client_secret":"xxxxx","code":"xxxx"} 请求示例 http://${host}:${port}/pamirs/sso/oauth2/authorize 响应说明 {"code":"0","msg":"成功","data":{"access_token":"xxxxx","expires_in":7200,"refresh_token":"xxxxxx","refresh_token_expiresIn":604800}} 备注 — 3.2 根据token获取用户信息 分类 说明 请求地址(开发环境) http://${host}:${port}/pamirs/sso/oauth2/getUserInfo 请求地址(测试环境) http://${host}:${port}/pamirs/sso/oauth2/getUserInfo 请求方式 POST 请求头 Authorization: Bearer xxxxxxxx 请求 Body {"client_id":"xxxx"} 请求示例 http://${host}:${port}/pamirs/sso/oauth2/getUserInfo 响应 {"code":"0","msg":"成功","data":{"name":"xxxxx","email":"xxxxx","login":"xxxxxx","id":"xxxxxxx"}} 备注 成功返回用户信息;失败返回错误码:1 根据实际情况其他协议的验证接口 3.3 单点登出接口 分类 说明 请求地址(开发环境) http://${host}:${port}/pamirs/sso/oauth2/logout 请求地址(测试环境) http://${host}:${port}/pamirs/sso/oauth2/logout 请求方式 POST 请求头 Authorization: Bearer xxxxxxxx 请求 Body {"client_id":"xxxx"} 请求示例 http://${host}:${port}/pamirs/sso/oauth2/logout 响应头 HTTP/1.1 200;Content-Type: application/html;charset=UTF-8 响应体 登出成功页面 备注 应用系统向 SSO 系统发起登出请求,SSO 收到后会通知所有其它系统登出该用户 四、服务注册 添加以下依赖 <!– sso相关 –> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-sso-api</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-sso-common</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-sso-server</artifactId> </dependency> 配置文件 pamirs sso: enabled: true server: loginUrl: http://127.0.0.1:8091/login authType:…

    2026年1月7日
    35400
  • IP黑白名单实现拦截三方用户

    已知厂商IP为10.139.0.1,经系统检测122.233.24.28、138.122.12.9为风险IP,需要禁止访问。 白名单配置:10.139.0.1 黑名单配置:122.233.24.28、138.122.12.9 厂商请求到Oinone开放平台请求头需携带X-Forwarded-For和X-Real-IP,例如: X-Forwarded-For 122.233.24.28 X-Real-IP 122.233.24.28 经Nginx代理后,oinone获取的请求头内容: X-Forwarded-For 122.233.24.28, 10.139.0.1 # 代理追加厂商IP到末尾 X-Real-IP 122.233.24.28 # 保持客户端原始值,Nginx不处理 效果:厂商10.139.0.1发送的请求且用户X-Real-IP不在黑名单内才放行。 注意事项 Nginx如果配置X-Real-IP需关闭,否则拿到的永远是厂商IP。 proxy_set_header X-Real-IP $remote_addr; 相关文章 开放应用中的ip黑白名单

    2025年5月15日
    48100
  • 前端自定义组件之锚点分组

    本文将讲解如何通过自定义,实现锚点组件。这个锚点组件会根据界面设计器拖入的分组,动态解析出锚点。 实现路径 整体的实现思路是界面设计器拖个容器类的组件(这里以选项卡为例),自定义这个选项卡,往选项卡里拖拽的每个分组,每个锚点的名称是分组的标题。 1. 界面设计器拖出页面 我们界面设计器拖个选项卡组件,然后在选项页里拖拽任意多个分组。完成后点击右上角九宫格,选中选项卡,填入组件 api 名称,作用是把选项卡切换成我们自定义的锚点分组组件,这里的 api 名称和自定义组件的 widget 对应。最后发布页面,并绑定菜单。 2. 组件实现 widget 组件重写了选项卡,核心函数 renderGroups,通过 DslRender.render 方法渲染界面设计器拖拽的分组。 import { BasePackWidget, DslDefinition, DslRender, SPI, Widget } from '@oinone/kunlun-dependencies'; import TabsParseGroup from './TabsParseGroup.vue'; function fetchGroupChildren(widgets?: DslDefinition[], level = 1): DslDefinition[] { if (!widgets) { return []; } const children: DslDefinition[] = []; for (const widget of widgets) { if (widget.widget === 'group') { children.push(widget); } else if (level >= 1) { fetchGroupChildren(widget.widgets, level – 1).forEach((child) => children.push(child)); } } return children; } @SPI.ClassFactory( BasePackWidget.Token({ widget: 'TabsParseGroup' }) ) export class TabsParseGroupWidget extends BasePackWidget { public initialize(props) { super.initialize(props); this.setComponent(TabsParseGroup); return this; } // 获取分组的子元素 public get groupChildren(): DslDefinition[] { return fetchGroupChildren(this.template?.widgets); } @Widget.Reactive() public get groupTitles() { return this.groupChildren.map((group) => group.title); } // 根据容器子元素渲染左侧 @Widget.Method() public renderGroups() { if (this.groupChildren && this.groupChildren.length) { return this.groupChildren.map((group) => DslRender.render(group)); } } } vue组件核心内容是用component :is属性,渲染出配置的分组组件 <template> <div class="TabsParseGroup"> <a-anchor :affix="false"> <a-anchor-link v-for="(item, index) in groupTitles" :href="`#default-group-${index}`" :title="item" /> </a-anchor> <div v-for="(item, index) in groupComponents" :id="`default-group-${index}`"> <component :is="item" /> </div> </div> </template> <script lang="ts"> import { computed, defineComponent, PropType } from 'vue'; export default…

    2025年7月8日
    41400
  • 新人引导文档

    类型 文档链接 入门参考必看 7天入门到精通 Oinone 初级学习路径 Oinone 初级学习路径 平台部署启动 无代码docker启动说明 低代码启动说明 前端环境和启动前端工程 无代码设计器启动方式 后端无代码设计器Jar包启动方法 平台部署及依赖说明 Oinone平台部署及依赖说明(v5.0) 问题排查方法 问题排查工具使用手册 前后端研发帮助文档 前端文档 后端文档 项目开发实践要点 【前端】项目开发前端知识要点地图 【后端】项目开发后端知识要点地图 版本升级说明 版本更新日志 工具包 【附件一】下载说明 许可证使用说明 pamirs-license 许可证使用常见问题 更多文档新人引导建议,可以下方评论

    2024年7月15日
    1.6K00

Leave a Reply

登录后才能评论