企业java项目目录结构

原创

mob649e81583204 2023-09-12 17:35:12 ©著作权

文章标签 spring java Java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e81583204的原创作品，请联系作者获取转载授权，否则将追究法律责任

企业Java项目目录结构

简介

在企业级Java项目开发中，良好的项目目录结构是非常重要的。合理的目录结构可以提高代码的可读性、可维护性和可扩展性，使开发团队更加高效地协同工作。本文将介绍一种常用的企业Java项目目录结构，以及其中各个目录的作用和示例代码。

目录结构

一个典型的企业Java项目目录结构如下所示：

├─ src
│   ├─ main
│   │   ├─ java
│   │   │   ├─ com.example.project
│   │   │   │   ├─ config
│   │   │   │   ├─ controller
│   │   │   │   ├─ model
│   │   │   │   ├─ repository
│   │   │   │   ├─ service
│   │   │   │   ├─ util
│   │   │   │   └─ ProjectApplication.java
│   │   │   └─ resources
│   │   │       ├─ static
│   │   │       ├─ templates
│   │   │       └─ application.properties
│   │   └─ resources-test
│   ├─ test
│   │   ├─ java
│   │   │   └─ com.example.project
│   │   │       ├─ controller
│   │   │       ├─ service
│   │   │       └─ ProjectApplicationTests.java
│   │   └─ resources
│   │       └─ application-test.properties
│   └─ pom.xml
└─ README.md

下面是每个目录的作用和示例代码：

src/main/java：项目的Java源代码目录。在该目录下，按照包名组织代码。例如，com.example.project是示例项目的根包名。

所有的Java类文件都应该放在对应的包目录下，例如：

package com.example.project.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {
    
    @GetMapping("/")
    public String home() {
        return "index";
    }
}

src/main/resources：项目的资源文件目录。在该目录下，可以放置项目的配置文件、静态文件和模板文件等。

例如，application.properties是Spring Boot项目的配置文件，可以在该文件中配置数据库连接、端口号等信息：
```
spring.datasource.url=jdbc:mysql://localhost:3306/db_example
spring.datasource.username=user
spring.datasource.password=pass
server.port=8080
```
static目录用于存放静态文件，例如CSS、JavaScript、图片等。

templates目录用于存放模板文件，例如Thymeleaf模板等。

src/test/java：项目的测试代码目录。在该目录下，按照包名组织测试代码。例如，可以在com.example.project.controller包下创建测试类：

package com.example.project.controller;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

@WebMvcTest(HomeController.class)
public class HomeControllerTests {
    
    @Autowired
    private MockMvc mockMvc;
    
    @Test
    public void testHome() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/"))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.view().name("index"));
    }
}

src/test/resources：测试代码的资源文件目录。例如，可以在application-test.properties中配置测试环境的数据库连接信息：
```
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=sa
spring.datasource.password=
```