应用项目结构

在本地创建的应用项目是标准的 Maven 项目,可以按照通用的方式进行源码管理和自动化持续构建。

不同的应用模板生成的应用项目结构不同,但都遵照 Maven 项目结构 pom.xml 的标准配置。

Git 友好支持

GDK 在创建应用项目时,自动生成 .gitignore 文件加入了标准的文件忽略规则,开发者不需要额外配置忽略规则,可直接将项目目录加入 git 仓库。

单模块项目结构

项目内目录如下图所示

ROOT                                # 应用项目根目录
  |—— .gitignore                    # git 忽略规则文件
  |—— .gprj                         # gapp 项目元数据文件
  |—— pom.xml                       # 应用服务端入口模块的 Maven 配置文件(packing 为 gapp)
  |                                 
  |—— @conf                         # 应用在开发调试阶段的配置文件目录,配置不会发布到安装包; 
  |    |—— server.conf              # 应用开发调试的服务配置文件;       
  |    |                            # 当与其它配置文件出现相同项时,此配置的优先级最高; 
  |    |                                
  |    |—— mongo.db.conf            # 应用开发调试的 MongoDB 数据库配置文件;
  |    |__ log4j2.xml               # 应用开发调试的日志配置文件;
  |                                 
  |—— @install                      # 应用在发布安装阶段的发布制品根目录; 
  |    |__ conf                     # 应用安装包的配置文件目录;     
  |         |—— server.conf         # 当与其它配置文件出现相同项时,此配置的优先级最高;   
  |         |                              
  |         |—— mongo.db.conf       # 应用安装包的 MongoDB 数据库配置文件;    
  |         |__ log4j2.xml          # 应用安装包的日志配置文件;
  |                                 
  |—— @profiles                     # 应用的功能菜单配置目录,不区分开发调试阶段和安装阶段; 
  |    |—— application.profile      # 主功能菜单配置(必须);     
  |    |__ other.profile            # 其它功能菜单配置,可选;  
  |                                 
  |—— auto-src                      # 进行了编译后才自动生成的源代码目录
  |                                 
  |—— src                           # 服务端模块的源代码目录
  |    |—— main                     # 主源代码目录
  |    |    |—— java                # java 源代码目录
  |    |    |__ resources           # 资源目录
  |    |                            
  |    |__ test                     # 测试源代码目录
  |                                 
  |__ web                           # 前端模块项目目录(vue 工程,npm + vite)
      |                             
      |—— package.json              # npm 工程配置文件;
      |—— vite.config.js            # vite 构建配置文件;
      |__ src                       # 前端源代码目录
           |__ views                # 前端的视图组件根目录;
                                    # 目录下的每一个 .vue 文件都视为一个视图组件,被自动地赋予一个由文件名称命名的路由路径;
                                    # 例如:视图组件 views/simple-form.vue 的路由路径是 /simple-form ;

多模块项目结构

项目内目录如下图所示

ROOT                                      # 应用项目根目录
  |—— .gitignore                          # git 忽略规则文件
  |—— .gprj                               # gapp 项目元数据文件
  |—— pom.xml                             # 根模块的 Maven 配置文件
  |                                       
  |—— server                              # 服务端模块的项目目录
  |   |—— pom.xml                         # 应用服务端入口模块的 Maven 配置文件(packing 为 gapp)
  |   |                                   
  |   |—— @conf                           # 应用在开发调试阶段的配置文件目录,配置不会发布到安装包; 
  |   |    |—— server.conf                # 应用开发调试的服务配置文件;       
  |   |    |                              # 当与其它配置文件出现相同项时,此配置的优先级最高;       
  |   |    |                               
  |   |    |—— mongo.db.conf              # 应用开发调试的 MongoDB 数据库配置文件;       
  |   |    |__ log4j2.xml                 # 应用开发调试的日志配置文件;
  |   |            
  |   |—— @install                        # 应用在发布安装阶段的发布制品根目录; 
  |   |    |__ conf                       # 应用安装包的配置文件目录;     
  |   |         |—— server.conf           # 应用安装包的服务配置文件;       
  |   |         |                         # 当与其它配置文件出现相同项时,此配置的优先级最高;        
  |   |         |       
  |   |         |—— mongo.db.conf         # 应用安装包的 MongoDB 数据库配置文件;    
  |   |         |__ log4j2.xml            # 应用安装包的日志配置文件;
  |   |                                   
  |   |—— @profiles                       # 应用的功能菜单配置目录,不区分开发调试阶段和安装阶段; 
  |   |    |—— application.profile        # 主功能菜单配置(必须);     
  |   |    |__ other.profile              # 其它功能菜单配置,可选;         
  |   |                                   
  |   |—— auto-src                        # 进行了编译后才自动生成的源代码目录
  |   |                                   
  |   |__ src                             # 服务端模块的源代码目录
  |        |—— main                       # 主源代码目录
  |        |    |—— java                  # java 源代码目录
  |        |    |__ resources             # 资源目录
  |        |                              
  |        |__ test                       # 测试源代码目录
  |                                       
  |__ ${appCode}-ui                       # 前端模块项目目录(vue工程,npm + vite)
       |                                  # 项目目录由“应用编码” + 后缀“-ui” 命名
       |                                  
       |—— package.json                   # npm 工程配置文件;
       |—— vite.config.js                 # vite 构建配置文件;
       |__ src                            # 前端源代码目录
最近更新: 8/10/2024, 4:21:50 PM
发布者: huanghaiquan
扫码咨询