Portfolio Performance 项目开发环境配置与贡献指南

Portfolio Performance 项目开发环境配置与贡献指南

portfolio Track and evaluate the performance of your investment portfolio across stocks, cryptocurrencies, and other assets. 项目地址: https://gitcode.com/gh_mirrors/por/portfolio

项目概述

Portfolio Performance 是一款基于 Eclipse RCP 框架开发的个人投资组合管理工具，主要用于跟踪和分析个人投资组合的表现。该项目采用模块化架构设计，支持多种金融数据导入格式，并提供丰富的报表功能。

开发环境搭建

基础软件准备

开发 Portfolio Performance 需要以下基础软件：

1. Java 开发环境：需要 Java 21 JDK，推荐使用 Azul 提供的版本
2. Eclipse IDE：必须使用 Eclipse IDE for RCP and RAP Developers 版本

Eclipse 插件安装

为了高效开发，建议安装以下 Eclipse 插件：

1. 核心开发插件：

   • Eclipse PDE (插件开发环境)
   • M2E PDE Integration (Maven 集成)

2. 开发辅助工具：

   • Infinitest (实时测试工具)
   • ResourceBundle Editor (资源文件编辑器)
   • Checkstyle Plug-In (代码风格检查)
   • SonarLint (代码质量分析)

3. 可选插件：

   • Darkest Dark Theme (深色主题)
   • Launch Configuration DSL (启动配置管理)

Eclipse 配置优化

推荐进行以下 IDE 配置优化：

1. 保存动作设置：

   • 启用代码格式化
   • 自动组织导入语句

2. 内容辅助设置：

   • 启用静态导入
   • 添加常用工具类到收藏夹

3. JRE 配置：

   • 确保使用 Java 21 JDK

项目结构与构建

源代码管理

项目采用标准的分支开发工作流：

1. 创建个人开发分支
2. 使用 Eclipse Git 集成工具克隆项目
3. 导入现有 Eclipse 项目

目标平台配置

项目使用 Eclipse 目标平台管理依赖：

1. 打开 portfolio-target-definition 项目
2. 使用 Target Editor 打开目标定义文件
3. 设置为活动目标平台

运行与测试

项目提供多种启动配置：

1. 主应用程序：通过 PortfolioPerformance 配置启动
2. 单元测试：
   • PortfolioPerformance_Tests 核心功能测试
   • PortfolioPerformance_UI_Tests 界面测试

Maven 构建

虽然主要开发使用 Eclipse IDE，但项目也支持 Maven 构建：

# Linux/macOS
export MAVEN_OPTS="-Xmx4g"
mvn -f portfolio-app/pom.xml clean verify

# Windows
set MAVEN_OPTS="-Xmx4g"
mvn -f portfolio-app\pom.xml -Denforcer.skip=true clean verify

核心功能开发指南

代码贡献规范

1. 提交信息：

   • 使用英文撰写清晰的提交信息
   • 关联问题编号或论坛讨论

2. 代码风格：

   • 使用项目自带的格式化配置
   • PDF 导入器代码保持原有格式

3. 测试要求：

   • 为新增功能添加测试用例
   • 避免修改现有测试文件内容

多语言支持

项目支持 13 种语言，翻译工作通过 POEditor 平台管理：

1. 字符串外部化：

   • 使用 Eclipse 的 Externalize Strings 功能
   • 遵循现有命名规范

2. 标签命名：

   • 使用 Label、Msg、Column 等前缀
   • 保持领域一致性

图形资源规范

1. 格式要求：

   • PNG 格式，透明背景
   • 16x16px 和 32x32px 两种尺寸

2. 颜色规范：

   • 主色调：橙色 (#f18f01)、蓝色 (#0e6e8e)
   • 状态颜色：红色 (错误)、黄色 (警告)

数据导入器开发

PDF 导入器

PDF 导入器是项目的核心功能之一：

1. 开发流程：

   • 用户选择 PDF 文件
   • PDF 转换为文本行数组
   • 导入器应用正则表达式提取交易

2. 调试工具：

   • 通过菜单生成 PDF 文本调试信息
   • 注意去除个人信息

3. 交易类型：

   • PortfolioTransaction (证券账户交易)
   • AccountTransaction (现金账户交易)

Interactive-Flex-Query 导入器

处理 XML 格式的交易报表：

1. 数据结构：

   • 必须包含根元素
   • 元素正确嵌套和闭合
   • 属性值使用引号

2. 交易元素：

   • 类型 (type)、数量 (quantity)
   • 金额 (amount)、货币 (currency)
   • 交易日期 (tradeDate)、描述 (description)

3. 测试规范：

   • 使用 XML 测试文件
   • 匿名化个人信息
   • 保持原始文件结构

开发建议

1. 代码审查：提交前检查代码风格和测试覆盖率
2. 文档更新：新增功能时更新相关文档
3. 性能考量：大数据量操作注意内存使用
4. 异常处理：完善的错误处理和用户反馈

通过遵循这些指南，开发者可以高效地为 Portfolio Performance 项目做出贡献，同时保持代码质量和项目一致性。

portfolio Track and evaluate the performance of your investment portfolio across stocks, cryptocurrencies, and other assets. 项目地址: https://gitcode.com/gh_mirrors/por/portfolio