# 父项目

**Repository Path**: foundryx/fx-parent

## Basic Information

- **Project Name**: 父项目
- **Description**: 父项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-19
- **Last Updated**: 2026-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 父项目

#### 介绍
父项目

#### 软件架构
 是一个适用于 Java 8 的 Maven 父项目模板，用于统一子模块的构建规范和插件配置。该模板不强制管理依赖版本，而是提供标准化的编译、测试、打包等流程。

#### 核心目标

| 目标             | 描述                                              |
| ---------------- | ------------------------------------------------- |
| ✅ 统一编译配置   | 所有子模块默认使用 Java 8 和 UTF-8 编码           |
| ✅ 插件集中管理   | 提供标准的 Maven 插件配置（如编译、测试、打包等） |
| ✅ 易于扩展       | 支持添加代码检查、格式化、文档生成等插件          |
| ❌ 不强制依赖版本 | 各子模块可自行决定所使用的第三方库及版本          |
| ❌ 不做模块聚合   | 每个模块独立开发、构建、部署                      |

#### 快速开始

在你的模块 `pom.xml` 中继承 `fx-parent`：

``` 
<parent>
    <groupId>com.foundryx</groupId>
    <artifactId>fx-parent</artifactId>
    <version>1.0.0</version>
</parent>
```

####  插件说明

| 插件                    | 用途           | 推荐命令                                      |
| ----------------------- | -------------- | --------------------------------------------- |
| maven-compiler-plugin   | 编译 Java 代码 | `mvn compile`                                 |
| maven-surefire-plugin   | 执行单元测试   | `mvn test`                                    |
| maven-jar-plugin        | 打包 jar 文件  | `mvn package`                                 |
| maven-javadoc-plugin    | 生成 API 文档  | `mvn javadoc:javadoc`                         |
| maven-source-plugin     | 打包源码       | `mvn source:jar`                              |
| spotless-maven-plugin   | 代码格式化     | `mvn spotless:apply`                          |
| maven-checkstyle-plugin | 代码规范检查   | `mvn checkstyle:check`                        |
| jacoco-maven-plugin     | 测试覆盖率报告 | `mvn jacoco:prepare-agent test jacoco:report` |

#### 指南建议

1. **统一命名规范**
   - 包名：`com.foundryx.module.xxx`
   - 类名：大写驼峰（`UserService`, `DataSyncJob`）
   - 方法名：小写驼峰（`getUserById`, `initCache()`）
2. **推荐工具链**
   - IDE：IntelliJ IDEA / Eclipse（需启用 Java 8 支持）
   - JDK：Oracle JDK 8 或 OpenJDK 8
   - Maven：3.6.x 及以上版本
3. **编码风格**
   - 使用 Lombok 减少样板代码
   - 日志统一使用 SLF4J + Logback
   - 工具类封装在 `fx-shared` 中复用

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 https://gitee.com/foundryx 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)