Comunes/Kune项目开发指南：从环境搭建到代码实践

1. 开发环境搭建

1.1 基础工具准备

在开始Comunes/Kune项目开发前，需要安装以下基础工具（以Ubuntu/Debian为例）：

sudo apt-get install git maven2 mercurial openjdk-7-jdk

这些工具分别用于：

• Git：代码版本控制
• Maven：依赖管理
• Mercurial：Wave In a Box(WIAB)依赖
• OpenJDK 7：Java开发环境

1.2 Eclipse IDE配置

推荐使用Eclipse作为开发IDE，需要安装以下核心插件：

1. Google插件套件：

   • GWT开发工具
   • GWT Designer（可视化UI设计工具）

2. 版本控制插件：

   • EGit（Git集成）

3. Java EE开发工具

安装完成后，需配置：

• 设置默认使用Java 1.7
• 配置M2_REPO变量指向本地Maven仓库（通常位于~/.m2/repository）
• 设置项目文本编码为UTF-8

1.3 代码获取与项目导入

获取项目代码：

git clone https://github.com/comunes/kune.git

项目导入Eclipse步骤：

1. 在项目根目录执行：./bin/mvn-eclipse.sh
2. 在Eclipse中选择：File > Import > Existing Projects into Workspace

2. GWT开发环境配置

2.1 GWT SDK设置

Comunes/Kune使用GWT 2.7.0版本，需手动配置：

1. 下载GWT 2.7.0 SDK
2. 在Eclipse中：Windows > Preferences > Google > Web Toolkit > Add

2.2 开发模式选择

项目支持两种开发模式：

传统Hosted Mode：

1. 先编译：mvn compile -Dliquibase.should.run=false
2. 部署：bin/deploy_gwt.sh
3. 分别运行服务端和客户端

SuperDev Mode（推荐）：

1. 启动代码服务器：mvn gwt:run-codeserver -P development
2. 访问：http://localhost:9876/
3. 将开发模式书签拖到浏览器工具栏
4. 启动应用后通过书签控制编译

3. 项目结构与核心技术

3.1 代码组织结构

• 客户端代码：包名包含"client"
• 服务端代码：包名包含"server"
• 共享代码：包名包含"shared"

3.2 核心技术栈

服务端技术：

• Guice：轻量级依赖注入框架
• Apache OpenJPA：Java持久化API实现
• Guice Persist：集成Guice和JPA
• Lucene：全文检索功能

客户端技术(GWT)：

• GIN：GWT版的Guice
• Emite：XMPP协议实现
• UI Binder：声明式UI设计
• ext-gwt/gxt：富客户端组件库

4. 开发实践指南

4.1 编码规范

• 缩进：使用空格而非Tab
• 字符编码：统一使用UTF-8
• 代码风格：遵循项目现有风格

4.2 设计模式应用

1. MVC模式：

   • 清晰分离视图、控制器和模型
   • 特别适用于GWT应用开发

2. 控制反转(IoC)：

   • 通过Guice/GIN实现依赖注入
   • 提高代码可测试性和可维护性

4.3 测试策略

1. 单元测试：

   • 使用JUnit框架
   • 覆盖核心业务逻辑

2. 持续集成：

   • 通过Jenkins实现自动化构建和测试
   • 每次提交触发完整构建流程

5. 实用开发技巧

5.1 调试技巧

• 服务端调试：使用kune-server-via-mvn.launch配置
• 客户端调试：
  • Chrome开发者工具（F12）
  • 启用JS Source Maps
  • 通过Console查看日志

5.2 性能优化

• 内存设置：为GWT Hosted Mode配置-Xmx1024M
• 代码分割：合理使用GWT的代码分割特性
• 延迟绑定：利用GWT的延迟绑定减少初始加载量

6. 常见问题解决

1. GWT SDK版本问题：

   • 确保使用GWT 2.7.0
   • 检查Eclipse中GWT插件配置

2. 字符编码问题：

   • 确认项目设置为UTF-8
   • 检查文件实际编码格式

3. 依赖问题：

   • 定期执行mvn clean install
   • 检查本地仓库完整性

7. 进阶开发资源

1. 架构图：参考项目中的kune-arch.png（注意可能已过时）
2. 数据库Schema：查看cc.kune.domain包中的Java类
3. 操作转换(OT)：研究Apache Wave相关实现
4. UI开发：利用项目提供的Sandbox环境测试UI组件

通过本指南，开发者可以快速搭建Comunes/Kune项目的开发环境，理解项目架构，并掌握核心开发技术。项目采用了现代化的Java Web开发技术栈，结合了GWT的丰富客户端能力和稳健的服务端技术，为开发复杂的协作应用提供了坚实基础。