Project structure layout

已于 2023-05-26 01:33:30 修改
阅读量410 收藏 1
点赞数
分类专栏： Project 文章标签： java spring spring boot
于 2018-10-10 13:01:56 首次发布
知识在分享中升华，思想在交流中沉淀。
本文链接：https://blog.csdn.net/qwfys200/article/details/82995443
版权

project structure layout

Problem

  经常会在项目中看到很糟糕的项目结构与项目组织方式，比如代码可读性不高、组织结构诡异、命名言不达意且前后不致等。

  前段时间看到阿里巴巴出了一个关于Java代码规范的小册子，感觉非常的好，但是很多时候，并不是所有的项目都是基于大型分布式架构的，所以这里针对小型项目代码组织方式做了一些调整，并基于目前最流行的Spring boot项目结构来展开。

Resolve

  下面是一个全新的项目结构图：

在这里插入图片描述

  现项目结构图简要说明如下：

ItemDescriptionRemarks
xihu项目根目录无
README.md引导说明文档无
doc文档目录无
CHANGELOG发布版本日志无
pom.xml项目对象模型，名称不可更改，具体可参见maven规范无
src/main/javajava源码目录，按maven规范，里面全是*.java文件无
src/main/sources配置文件根目录无
src/test/java测试用例java项目根目录无
src/test/sources测试用例配置文件根目录无
com.qwfys.app.xihu包根路径无
com.qwfys.app.xihu.controller业务控制器层包路径DepartmentController
com.qwfys.app.xihu.controller.view业务控制器层Java Bean包路径DepartmentView
com.qwfys.app.xihu.business业务逻辑层包路径无
com.qwfys.app.xihu.business.spec业务逻辑层业务逻辑接口包路径DepartmentBusiness
com.qwfys.app.xihu.business.impl业务逻辑层业务逻辑实现包路径DepartmentBusinessImpl
com.qwfys.app.xihu.business.model业务逻辑层Java Bean包路径DepartmentModel
com.qwfys.app.xihu.data数据访问层包路径无
com.qwfys.app.xihu.data.repository数据访问层主入口包路径无
com.qwfys.app.xihu.data.repository.spec数据访问层主入口接口包路径DepartmentRepository
com.qwfys.app.xihu.data.repository.impl数据访问层主入口实现包路径DepartmentRepositoryImpl
com.qwfys.app.xihu.data.mapper数据访问层MyBatis映射包路径DepartmentMaper
com.qwfys.app.xihu.data.domain数据访问层Java Bean映射包路径DepartmentDomain
com.qwfys.app.xihu.data.redis.spec数据访问层Redis接口包路径DepartmentRedis
com.qwfys.app.xihu.data.redis.impl数据访问层Redis实现包路径DepartmentRedisImpl
com.qwfys.app.xihu.data.mongo.spec数据访问层Mongo接口包路径DepartmentMongo
com.qwfys.app.xihu.data.mongo.impl数据访问层Mongo实现包路径DepartmentMongoImpl
com.qwfys.app.xihu.common通用代码包路径无
com.qwfys.app.xihu.common.base通用代码基类包路径无
com.qwfys.app.xihu.common.constant通用代码常量包路径无
com.qwfys.app.xihu.common.enums通用代码枚举包路径无
com.qwfys.app.xihu.common.exception通用代码业务异常包路径无
com.qwfys.app.xihu.common.util通用代码工具类包路径无
com.qwfys.app.xihu.config配置代码包路径无
com.qwfys.app.xihu.webservelet相关包路径无
com.qwfys.app.xihu.converter转换相关包路径无
com.qwfys.app.xihu.XihuApplication项目入口无
com.qwfys.app.xihu.XihuApplicationTests测试样例无
application.yml配置文件无
application-snapshot.yml每日构建环境配置文件无
application-alpha.ymlalpha环境配置文件无
application-beta.ymlbeta环境配置文件无
application-release.ymlrelease环境配置文件无
com/qwfys/app/xihu/data/mapperMyBatis SQL-Mapping配置文件目录无
config/mybatis/mybatis-config.xmlMybatis配置文件无
staticspring boot静态资源目录无
templatespring boot模板目录无
logback.xmllogback日志系统配置文件无

Feature

  1、整个项目结构的设计主要针是对前后端不分离的情形的。对于前后端分离的情形来说，整个项目结构也是完全适用的，无非是将前端静态资源相关东西拿掉，与此同时借助Swagger UI之类的组件对外输出接口文档，并对外提供标准的Restful风格的api即可。

  2、整个项目结构的设计主要参照了敏捷开发的理念，遵循代码即是文档的项目开发理念，项目文档通过README.md、Swagger UI、CHANGELOG展开。其中，README.md主要用于对项目做整体性描述；Swagger UI主要用于输出项目接口文档；CHANGELOG主要用于记录项目版本之间的功能变化。

  3、整个项目结构的设计在命名上参考了领域模型设计的理念，采用后续法来清晰整个项目的结构，如User这个领域对象，在项目中各层相关的元素有UserController、UserBusiness、UserBusinessImpl、UserRepository、UserMapper、UserMapper.xml、UserDomain、UserModel、UserView等，后续有特定的语境、语意。

  4、整个项目结构的设计在Java包的命名上采用了应用即是服务的设计的理念，包的命名由组织名.层次类型.应用名做为包的根路径，如com.qwfys为组织名，app代表业务应用，如果是基础框架，则是framework，xihu为应用名，也就是说，xihu是一个可以独立部署的服务。

  5、整个项目结构的设计部署上参考了每日构建(snapshot)、内测一(alpha)、内测二(beta)、发布(release)的研发流程，针对研发活动的每一阶段都有与之对应的运行环境与之对应，项目在不同的环境中启动只要添加不同的启动参数即可。

  eg. 要在beta环境中以源码方式启动项目，可以用如下方式启动：

lwk@qwfys ~/ $ cd project/com/qwfys/xihu
lwk@qwfys:~/Public/project/com/qwfys/xihu$
lwk@qwfys:~/Public/project/com/qwfys/xihu$ mvn spring-boot:run -Dspring-boot.run.profiles=beta

  eg. 要在beta环境中以jar包方式启动项目，可以用如下方式启动：

lwk@qwfys ~/ $ cd project/com/qwfys/xihu
lwk@qwfys:~/Public/project/com/qwfys/xihu$
lwk@qwfys:~/Public/project/com/qwfys/xihu$ mvn clean install -Dmaven.test.skip=true
lwk@qwfys:~/Public/project/com/qwfys/xihu$ java -jar target/xihu-0.0.1-SNAPSHOT.jar --spring.profiles.active=test

Summary

  这里针对小型项目结构参照Spring boot、领域驱动模型、敏捷开发、应用即是服务等理念做了一个设计，兼顾到了前后端分离与前后端不分离两种情型，让项目结构更清晰。

  当下微服务架构已经深入人心，对于微服务的项目来讲，这种项目结构也是适用的，结合Spring Cloud来构建微服务时，只需要做少量调整即可。

Reference

qwfys200
关注
专栏目录
【Chapter 4 .NET 8.0 ASP.NET Core BookQuerySystem: Project Layout】
代数的博客
07-21 181
【代码】【Chapter 4 .NET 8.0 ASP.NET Core BookQuerySystem: Project Layout】
project-layout:示例项目布局
04-01
Golang项目结构 无服务器布局示例 小路 内容 走？ 笔记 / README.md，Makefile，go.mod，无Go代码 不 /资产 电子邮件模板，图像等 不 /配置 配置文件 不 /厘米 应用程序（主文件，lambda） 是的 /D b 数据库架构和迁移 不 已经有架构，可能还不错 /部署 部署配置（云形成） 不 鉴于涉及的复杂性，可能不值得从根本上转移 / docs 设计和用户文档 不 /内部的 私人应用程式和程式库程式码 是的 由编译器强制执行 /公斤 可以安全共享的库代码 值得商bat的 /测试数据 测试治具 不 标准库惯例 /工具 支持工具，例如CLI 是的 /小贩 应用程序依赖 不 不在.git中，由go mod管理 示例库布局 小路 内容 走？ 笔记 / README.md，go.mod，仅此而已 可能是 /内部的 私人图书馆代码 是的 由编译器强
IDEA中每天都在用的Project Structure，你了解多少？
程序新视界
10-19 2万+
Idea这款开发工具的便利之一是很多配置项几乎可直接使用默认项。但针对不同的项目难免需要针对性的配置，本文带大家详细的梳理一遍Project Structure中各项功能，注意收藏，以备不时之需。 先说一下写本文的缘由，在项目中用Idea中打开一组SpringBoot项目，结果编译的结果和日志输出的地方与预期不一致，于是仔细研究了Project Structure的配置项，发现此处竟然有很多有用的功能，汇总分享给大家。 Project Structure即“项目结构”，它几乎涵盖了一个项目所有的个性化的配置
Android Project layout
独自登高楼 望断天涯路
12-04 1593
The Android platform consists of several projects already in progress. These projects can be divided into three categories: Core projects:  These projects make up the foundation of the Android p
IDEA Project Structure（项目结构）详解
热门推荐
weixin_43611145的博客
10-21 3万+
Idea Project Structure（项目结构）详解1.构成2.Project Settings（项目设置）2.1 Project（项目设置）2.2 Modules（模块设置）2.3 Libraries（类库设置）2.4 Facets2.5 Artifacts3.Platform Settings（平台设置）3.1 SDKs（SDK设置）3.2 Global Libraries（全局类库）...
IntelliJ IDEA（七） ：Project Structure
qq_30905243的博客
10-10 205
IntelliJ IDEA（七） ：Project Structure Project Structure# “项目结构”对话框允许您管理项目和IDE级别的元素，例如Modules，Facets，Libraries， Artifacts和SDK。 在大多数情况下，左边部分有两个窗格实现了两级选择器。唯一的例外是当你选择项目，在这种情况下只有一个选择器窗格。 打开方式有两种： 1. 通过工具栏 2.通过快捷键 Ctrl+Shift+Alt+S Project# 指定项目名...
PyCharm Python Project Structure Analysis: Understanding the Project Layout for Enhanced Development...
Overview of PyCharm Python Project Structure PyCharm is a powerful Python Integrated Development Environment (IDE) that provides comprehensive project management features to help developers organize...
react-layout:该项目是 react.JS 最佳布局
05-31
在"react-layout"项目中，我们可以看到React.js的最佳实践应用在布局设计上。 1. **React组件**：React的核心概念是组件，它允许我们将UI拆分成独立、可重用的部分。项目中的每个文件可能就是一个React组件，比如...
Build the 'I am Rich' App to learn about project structure and XML
04-20
- **布局文件（layout）**: 通常位于`res/layout`目录下，如`activity_main.xml`，定义了应用界面的视图结构。例如，可以使用`<LinearLayout>`、`<RelativeLayout>`或`<ConstraintLayout>`作为根节点，然后添加按钮...
ssm框架搭建
m0_53654810的博客
03-29 662
第一步(创建maven项目) 创建一个项目 选择maven模板 设置项目名称(组名即包名) 选择maven存储路径 第二步(新建相应的目录结构) 打开后发现目录结构只有webapp，则新建java和resource文件 将java和resource文件分别设为sources和resource 点击file-》project structure，进入此页面，设置完成后点击apply在点击OK 第三步(添加项目所需的依赖) 配置pom.xml文件 <prop...
Go Project Layout 的设计
chengshannei7891的博客
08-07 606
Go Project Layout 的设计 背景 Go 没有对项目的 layout 有硬性规定，也没有官方版本的 best practice，所以社区内部有几种不同的实践方式，可根据自身需求自行参考。本文仅作简要总结。 参考方案 根据社区Standard Go Proje...
Project Structure
weixin_44792849的博客
04-02 2321
什么是Project Structure？ 顾名思义，就是项目结构。 分为两种配置，对单个项目的配置信息和全局配置信息。 1、对单个项目的配置 Project name：项目名，使用此字段编辑项目名称。 Project SDK：项目SDK，选择项目SDK。如果所需SDK不在列表中，请单击“ New”，然后选择所需的SDK类型。然后，在打开的对话框中，选择SDK主目录，然后单击确定。要查看或编辑所选SDK的名称和内容，请单击"Edit"。 Project language level：选择要支
项目布局
Symbol_Long的专栏
04-12 1220
项目布局 我们推荐Tapestry使用此布局，由 快速开始Tapestry文档 创建的文件和文件夹布局。如果你正使用Ant创建你自己的构造工具，你也许会使用任何使你方便工作的方法...只要他们在WAR包里生成到合适的位置。 项目部分布局模仿了一个爆炸WAR（一个未解压到文件系统的的WAR文件）的格式。我们在开发时，经常直接在工作空间运行你的应用而不需要特殊的编译或打包过程。 大多数
(干货)【intellij idea】Project Structure 讲解
sunwenxu的博客
04-23 4387
目录结构介绍 Project Project language level：选择要支持的Java语言级别。选定的级别将被用作项目默认值。 可用选项对应于JDK版本： 1.3 - 普通的旧Java 1.4 - “断言”关键字 5.0 - 'enum’关键字，自动装箱等 6.0 - @Override在接口 7.0 - 钻石，ARM，多捕获等 8.0 - Lambda支持，类型注释等 Modu...
【intellij idea】Project Structure 讲解
qq_28657577的博客
10-28 336
原文地址https://www.cnblogs.com/zadomn0920/p/6196962.html 项目的左侧面板 项目设置->Project Project Settings -> Modules Sources面板 Paths面板 dependencies面板 Project Settings - > Libraries Project Settings - > Facets ...
Kubernetes — Project Layout 与 cmd 入口设计
烟云的计算
11-21 1402
目录 文章目录目录Kubernetes Project Layout Kubernetes Project Layout Kubernetes 由 Golang 编写，Golang 社区提出了 Standard Go Project Layout 方案，以对 Golang 项目的目录结构进行规范划分。 根据 Standard Go Project Layout 方案，我们对标一下 Kubernetes Project Layout 的设计。 由于 Kubernetes 项目全球开发者众多，这导致早期的代码
J2EE Project Layout
Wong Tseng's Column
10-11 568
工程目录结构：project root (/)|---src|      |---dao|      |---service|      |---web|---test|      |---dao|      |---service|      |---web|---context|      |---WEB-INF|      |---struts-config|      |---tl
带你深入了解IDEA的Project Structure(1)
2401_84049200的博客
04-21 1409
这个月马上就又要过去了，还在找工作的小伙伴要做好准备了，小编整理了大厂java程序员面试涉及到的绝大部分面试题及答案，希望能帮助到大家《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！[外链图片转存中…(img-UPcB1TKb-1713663831930)]《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
android studio使用layout
最新发布
06-27
- 打开项目结构（Project Structure），在`res/layout`目录下右键点击并选择"New" -> "Layout resource file"，为您的布局命名，比如activity_main.xml。 2. **编辑XML布局**： - 在新建的文件中，你可以添加各种...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

qwfys200

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值