如何为基于Xtext的DSL创建Eclipse新建项目向导？

我正好在Eclipse Oxygen.2 + Xtext 2.12.0这个组合上做过类似的项目向导开发，给你梳理下完整的实现步骤，跟着走应该就能顺利搞定：

1. 补全MWE2 Workflow中的项目向导配置 #

首先找到你的DSL生成脚本（一般叫GenerateMyDsl.mwe2），在Generator组件里添加项目向导的专属配置块——这是触发代码生成的核心开关：

component = Generator {
    // 保留你已有的language、fileExtensions等配置...
    
    // 新增项目向导生成配置
    projectWizard = {
        generate = true
        projectInfoClass = "org.xtext.example.mydsl.ui.wizard.MyDslProjectInfo"
        newProjectCreationPageClass = "org.xtext.example.mydsl.ui.wizard.MyDslWizardNewProjectCreationPage"
        // 若需要自定义模型文件创建页面，可在此继续添加modelFilePage配置
    }
}

这里的generate=true是开启向导生成的关键，后面两个类就是你已经看到的生成类，要确保包名和类名完全对应。

2. 完善MyDslProjectInfo类 #

这个类是项目的「信息大脑」，负责定义项目的结构、必备组件和初始文件。你需要重写几个核心方法：

• getFolders: 定义项目需要的文件夹结构（比如源码目录、资源目录）
• getRequiredNatures: 添加Xtext和必要的IDE Nature（比如Java Nature，如果你的DSL和Java结合）
• getBuilderIds: 绑定Xtext的构建器，确保DSL文件能被正确编译
• createInitialFiles: 创建初始的示例DSL文件或说明文档

示例代码参考：

@Override
protected List<String> getFolders() {
    return Arrays.asList(
        "src/main/java",
        "src/main/resources",
        "src/test/java"
    );
}

@Override
protected List<String> getRequiredNatures() {
    return Arrays.asList(
        "org.eclipse.jdt.core.javanature",
        "org.eclipse.xtext.ui.shared.xtextNature"
    );
}

@Override
protected void createInitialFiles(IProject project, IProgressMonitor monitor) throws CoreException {
    // 创建默认的DSL示例文件
    IFile exampleFile = project.getFile("src/main/resources/sample.mydsl");
    if (!exampleFile.exists()) {
        InputStream content = new ByteArrayInputStream("Hello MyDSL!".getBytes());
        exampleFile.create(content, true, monitor);
    }
}

3. 自定义MyDslWizardNewProjectCreationPage（可选但推荐） #

这个类对应向导的第一页（输入项目名、选择位置），默认生成的基础功能够用，但你可以扩展它添加自定义选项，比如是否创建示例文件、选择目标平台等：

@Override
public void createControl(Composite parent) {
    super.createControl(parent);
    Composite composite = (Composite) getControl();
    
    // 添加「创建示例文件」复选框
    Button createExampleBtn = new Button(composite, SWT.CHECK);
    createExampleBtn.setText("Create Sample DSL File");
    createExampleBtn.setSelection(true);
    // 将选择状态同步到ProjectInfo，后续创建文件时判断
    ((MyDslProjectInfo) getProjectInfo()).setCreateExample(createExampleBtn.getSelection());
}

4. 运行MWE2 Workflow生成完整向导代码 #

右键你的GenerateMyDsl.mwe2文件 → Run As → MWE2 Workflow。这一步会自动生成剩下的向导代码（比如MyDslNewProjectWizard.java），同时自动在plugin.xml中添加必要的扩展点配置。

5. 检查并优化plugin.xml的扩展点 #

运行MWE2后，plugin.xml会自动添加org.eclipse.ui.newWizards扩展点，你可以检查并调整细节：

<extension point="org.eclipse.ui.newWizards">
   <category
         id="org.xtext.example.mydsl.ui.category"
         name="MyDsl">
   </category>
   <wizard
         category="org.xtext.example.mydsl.ui.category"
         class="org.xtext.example.mydsl.ui.wizard.MyDslNewProjectWizard"
         icon="icons/obj16/MyDslFile.gif"
         id="org.xtext.example.mydsl.ui.wizard.MyDslNewProjectWizard"
         name="MyDsl Project">
   </wizard>
</extension>

可以替换icon为你自己的图标，调整name让向导更直观。

6. 测试向导功能 #

• 右键你的UI项目 → Run As → Eclipse Application，启动测试环境
• 在新窗口中点击File → New → Project...，找到你的MyDsl分类下的项目向导
• 按照向导步骤创建项目，检查是否生成了预期的文件夹、示例文件，且Xtext Nature和Builder已正确配置

常见问题排查 #

• 向导未出现在列表：检查plugin.xml的扩展点配置是否正确，确保UI插件已被加载
• 项目无Xtext Nature：核对MyDslProjectInfo中getRequiredNatures的ID是否正确（Xtext 2.12的Nature ID是org.eclipse.xtext.ui.shared.xtextNature）
• 示例文件未创建：检查createInitialFiles中的文件路径是否正确，是否有权限写入文件

内容的提问来源于stack exchange，提问作者Software Craftsman