【Java工程目录结构】项目结构和模块结构

为什么要注意项目结构？

1. 结构划分有利于管理文件。
2. 代码要放在 源文件文件夹（src/main/java）下才能正确编译和执行。

项目结构概述

一个项目project，包含任意个模块module。一个模块包含任意个包package。
包是类的容器，用于分隔类名空间。

1. 包的名字有层次关系，各层之间以点分隔：顶级域名.公司域名. 项目名. 模块名。例如：org.apache.rocketmq
2. 包名全部小写。

1. 项目目录

模块1
模块2
.gitignore
**.md

2. 模块目录

src：（source）存放所有资源和代码
        main：主程序
                ○ java（源 根）：.java文件。
                ○ resources（资源 根）：资源文件，如xml、properties配置文件。
                        templates：动态页面，如 thymeleaf 页面。
                                需要服务器渲染，所以直接访问是无意义的，也访问不到。
                        static：静态资源，如 html、css、js、image。
                                □ 可直接 localhost:8080/hello.html 访问该目录文件。
                                □ 也可 return "hello.html"; 跳转。
                        编译后，resources和源根在同一目录下！
                ○ lib：存放 jar包，需要设置添加到库。
                ○ webapp：web资源
                        页面静态资源：html、css、js、图片 
                        WEB-INF：固定写法。此目录下的文件不能被外部(浏览器)直接访问。
                                lib：jar包存放的目录
                                web.xml：web 项目的配置文件(3.0规范之后可以省略)
                                classes：target中，java编译生成class文件和资源文件存放的路径。对于war项目，配置文件中的classpath就是指这里。
        test：测试程序
                java（测试 根）：.java文件。
                resources（测试资源 根）：资源文件，如xml、properties配置文件。
pom.xml：maven 配置文件。
target：存放 Maven 构建当前模块，所生成的输出文件。
        classes：这就是 classpath。
                com.**：存放编译后的 .class 文件
                资源文件：src/main/resources 的所有文件。
模块配置文件.iml

2.1 java包

项目的 .java 源文件，必须标记为源根包。

2.1.1 业务处理的包：

        1. web/controller包
                表现层/展示层/视图层，用于接受请求。
                内容：Controller、Filter、Listener、Servlet 文件。
        2. service包
                服务层/业务层，用于处理业务。
                基础响应包的创建通常是在Service层实现类（ServiceImpl）中进行。
        3. dao（Data Access Object）包
                数据访问层，封装了对数据库的操作。

2.1.2 pojo包：普通bean，区别于EJB

        1. vo（View Object，视图对象）包
                应用场景：接收页面的请求数据；服务层 向表现层传递 用于页面展示的数据。
        2. dto（Data Transfer Object，数据传输对象）包
                应用场景：
                        § 表现层返回数据：为了安全去掉密码、获取实体列表时去掉正文、防 Map。
                        § 服务层之间传递数据。
                        § 持久层向服务层提供数据。
                特点：不包含业务逻辑。
        3. po（Persistant Object，持久化对象）包
                特点：不包含业务逻辑。setter 方法通常包含字段检验。
                        推荐由 XMyBatis 自动生成。
                应用场景：封装数据库表的一行数据。
        4. do（Domain Object、entry）包
                从现实世界中抽象出来的业务实体。
                        包含业务逻辑和数据访问的操作。
                        不关心数据库存储。可包含 controller 层不应知道的数据，如密码。
                        软件包名不可以是关键字名，故不能叫 do。
                        do 和 dto 的转换：构造函数、不推荐反射。

2.1.3 工具包：

        1. utils 包
                工具包，封装通用的工具类或方法，如日期处理、字符串处理、文件处理。
                这些工具比较独立，不依赖于其他模块或组件。
        2. common包
                封装通用的业务逻辑或者数据结构，如缓存、日志、异常处理。
                这些功能比较复杂，需要依赖于其他模块或组件。