ng-admin 0.6版本升级指南：配置API的重大变更

ng-admin 0.6版本升级指南：配置API的重大变更

ng-admin Add an AngularJS admin GUI to any RESTful API 项目地址: https://gitcode.com/gh_mirrors/ng/ng-admin

ng-admin作为一款优秀的前端管理界面框架，在0.6版本中引入了一些重要的API变更。本文将详细介绍这些变更内容，帮助开发者顺利升级到0.6版本，并为未来的0.7版本做好准备。

版本兼容性说明

ng-admin 0.6版本与0.5版本保持了向后兼容性，这意味着现有的0.5版本代码在0.6中仍然可以正常工作。然而，需要注意的是，0.6版本中引入的配置API变更将在0.7版本中成为强制要求。因此，建议开发者尽早按照新API进行升级，以避免未来版本升级时出现问题。

配置API的重大变更

0.6版本最显著的变化是废弃了直接使用new关键字实例化实体和字段的方式，转而采用工厂函数模式。这种变更带来了更清晰的API设计和更好的封装性。

基础配置变更

旧版配置方式：

app.config(function (NgAdminConfigurationProvider, Application, Entity, Field) {
    var admin = new Application('my admin');
    var post = new Entity('posts');
    post.listView().fields([
        new Field('title'),
        new Field('published_at').type('date'),
        new Field('body').type('wysiwyg')
    ]);
}

新版配置方式：

app.config(function (NgAdminConfigurationProvider) {
    var nga = NgAdminConfigurationProvider;
    var admin = nga.application('my admin');
    var post = nga.entity('posts');
    post.listView().fields([
        nga.field('title'),
        nga.field('published_at', 'date'),
        nga.field('body', 'wysiwyg')
    ]);
}

主要变更点：

1. 不再需要直接注入Application、Entity和Field等构造函数
2. 使用NgAdminConfigurationProvider(通常简写为nga)提供的工厂方法
3. 字段类型现在作为nga.field()的第二个参数直接传入，而不是后续调用.type()方法

关联关系字段的变更

关联关系字段(References)也采用了类似的变更方式，不再使用特定的构造函数，而是统一使用nga.field()配合类型参数。

旧版关联关系配置：

post.listView().fields([
    new ReferenceMany('tags')
        .targetEntity(tag)
        .targetField(nga.field('name'))
]);

新版关联关系配置：

post.listView().fields([
    nga.field('tags', 'reference_many')
        .targetEntity(tag)
        .targetField(nga.field('name'))
]);

关联关系类型对应表：

• Reference → 'reference'
• ReferenceMany → 'reference_many'
• ReferencedList → 'referenced_list'

升级建议

1. 尽早升级：虽然0.6版本仍然兼容旧API，但0.7版本将完全移除对旧API的支持，建议尽早完成升级。

2. 全局替换：可以使用IDE的全局替换功能批量修改new Field(为nga.field(，然后手动调整类型参数。

3. 测试验证：升级完成后，务必全面测试管理界面的各项功能，特别是关联关系的显示和操作。

4. 代码审查：建议团队进行代码审查，确保所有配置都按照新API规范编写。

总结

ng-admin 0.6版本的配置API变更代表了框架向更加一致和简洁的API设计迈进。通过采用工厂函数模式，开发者现在可以以更统一的方式创建各种类型的字段和实体。虽然这次变更需要开发者投入一些时间进行代码迁移，但从长远来看，这将使代码更加可维护，并为未来的功能扩展奠定更好的基础。

对于正在使用ng-admin的开发者，建议尽快按照新API规范更新代码，以确保未来能够平滑升级到0.7及更高版本。

ng-admin Add an AngularJS admin GUI to any RESTful API 项目地址: https://gitcode.com/gh_mirrors/ng/ng-admin