在Java里如何组织基础代码结构_Java语法规范解析

Java项目需严格遵循包命名(域名倒序全小写)、类职责单一(一文件一类)、main集中于启动类、资源按规范分层存放等约定,否则将引发协作混乱与运行时异常。

Java 项目不是把所有类塞进一个 src 文件夹就完事的——包结构混乱、类职责不清、命名随意,会导致编译不报错但协作时人人抓狂。

包名必须全小写且用域名倒序

这是 Java 的硬性约定,不是风格偏好。JVM 和大多数构建工具(如 Maven)依赖它做类加载和模块解析。

  • com.example.usermanager ✅ 合理:公司域名倒序 + 业务模块
  • Com.Example.UserManager ❌ 编译不报错,但 IDE 可能警告,Maven 构建时可能找不到资源
  • user.service ❌ 不符合反向域名规则,容易与其他库冲突(比如某 SDK 也叫 service

实际路径必须严格匹配:包声明 package com.example.auth; → 源文件必须放在 src/main/java/com/example/auth/ 下。

每个类只做一件事,且类名即职责

Java 没有强制限制一个文件多个类,但除内部类外,.java 文件应只含一个 public 类,且文件名与类名完全一致(大小写敏感)。

  • UserRepository.java 应只包含 public class UserRepository,专注数据库读写
  • 不要在 UserRepository.java 里塞 UserServiceUserValidator —— 它们该是独立类,各放各的文件
  • 工具方法别堆在“Utils”里:验证逻辑抽成 UserValidationRules,日期处理用 DateFormatters,而不是一股脑塞进 CommonUtils

否则很快会出现“改个邮箱校验,结果订单创建失败”的连锁故障。

main 方法只留在启动类里

public static void main(String[] args) 是 JVM 入口,但绝不该分散在十几个类中。它只属于项目的“门面”类,比如 Application.javaLauncher.java

  • Maven 项目中,main 方法通常只在 src/main/java/com/example/Application.java 中存在
  • 测试类(src/test/...)可以有临时 main,但提交前必须删掉或注释掉
  • 如果某个

    工具类需要调试,用单元测试(@Test)代替 main —— 更易复现、可自动化、不污染生产结构

否则 CI 流水线可能意外执行到某个测试用的 main,输出乱码日志甚至触发误操作。

资源文件和配置按环境分层放

硬编码路径或把 application.properties 直接扔在 src/main/java 下,是新手最常踩的坑。

  • 配置文件统一放 src/main/resources/,不同环境用 application-dev.propertiesapplication-prod.properties
  • SQL 脚本、JSON 样例、模板文件等静态资源,按用途建子目录:resources/sql/resources/templates/
  • 绝对不要在代码里写 new FileInputStream("config.txt") —— 改用 getClass().getResourceAsStream("/config/default.json"),确保打包进 JAR 后仍可读取

路径写死或资源位置随意,会导致本地运行正常,一打包成 JAR 就抛 NullPointerExceptionFileNotFoundException

真正难的不是记住这些规则,而是每次新建包、加类、放配置时,下意识停半秒问一句:“这个位置,别人拉下来第一眼能懂它该干什么吗?”