nbsaas-boot 注解详细介绍

bsaas-boot框架为Java开发者提供了一系列强大的注解，以简化代码编写和配置管理的工作。在本文中，我们将详细介绍一些核心注解，以帮助开发者更好地理解和充分利用这些注解的功能。

1. @CreateByUser

作用：

@CreateByUser注解用于在数据添加时默认注入当前登录用户的信息，标识实体对象的创建者信息，方便进行操作审计。

示例：

@CreateByUser
@Entity
public class MyEntity extends AbstractEntity {
    // Entity properties and methods
}

过这个注解，框架将自动注入当前登录用户的信息到创建者字段。

2. @ComposeView

作用：

@ComposeView注解指示实体对象可以用于构建组合视图，方便展示多个相关实体的信息。

示例：

@ComposeView
@Entity
public class CompositeEntity extends AbstractEntity {
    // Entity properties and methods
}

这个注解为实体对象提供了组合视图的功能，使其更加灵活多用途。

3. @FormAnnotation

作用：

@FormAnnotation注解用于定义表单的属性，包括标题和模型，方便前端展示。

示例：

@FormAnnotation(title = "My Form", model = "MyFormModel")
public class MyForm {
    // Form-related logic and properties
}

通过这个注解，我们可以定义表单的标题和模型，使前端开发更加方便。

4. @SearchItem

作用：

@SearchItem注解配置搜索项，定义在搜索时使用的名称、键、标签等信息。

示例：

@SearchItem(name = "name", key = "name", label = "Customer Name")
@Column(length = 30)
private String customerName;

这个注解帮助配置搜索项，方便在搜索功能中使用。

5. @FormField

作用：

@FormField注解是一个自定义注解，用于标识表单字段的各种属性，如标题、排序号、是否在表格中显示等。

示例：

@FormField(title = "Customer Name", sortNum = "1", grid = true, required = true)
@Column(length = 30)
private String customerName;

通过这个注解，我们可以定制化表单字段的行为，提高灵活性。

6. @Dict、@DictItem和 @DictKey

作用：

这组注解用于配置数据字典，包括字典项的值和标签。

示例：

@DictKey("auditState")
@Dict(items = {
        @DictItem(value = 0, label = "Pending"),
        @DictItem(value = 1, label = "Approved"),
        @DictItem(value = 2, label = "Rejected")
})
private Integer auditState;

通过这组注解，我们可以定义并使用数据字典，提高代码的可读性。

示例：Customer 实体

@CreateByUser
@ComposeView
@Data
@FormAnnotation(title = "客户", model = "客户")
@Entity
public class Customer extends AbstractUser {

    @Comment("客户名称")
    @SearchItem(name = "name", key = "name", label = "客户名称")
    @FormField(title = "客户名称", sortNum = "1", grid = true, required = true)
    @Column(length = 30)
    private String name;

    @Comment("真实姓名")
    @SearchItem(name = "realName", key = "realName", label = "真实姓名")
    @FormField(title = "真实姓名", sortNum = "2", grid = true, required = true)
    @Column(length = 30)
    private String realName;

    @Comment("联系电话")
    @FormField(title = "联系电话", sortNum = "3", grid = true)
    @Column(length = 30)
    private String phone;

    @Comment("身份证号码")
    private String idNumber;

    @Comment("身份证前面")
    private String frontIdCard;

    @Comment("身份证后面")
    private String backIdCard;

    @Comment("自拍照")
    private String selfFile;

    @Comment("性别")
    private String sex;

    @Comment("生日")
    private String birthDate;

    @DictKey("auditState")
    @Comment("审核状态 0待审核,1审核通过,2审核失败")
    @Dict(items = {
            @DictItem(value = 0, label = "待审核"),
            @DictItem(value = 1, label = "审核通过"),
            @DictItem(value = 2, label = "审核失败")
    })
    private Integer auditState;

    @Comment("备注")
    private String comment;
}

以上是nbsaas-boot框架中一些核心注解的详细介绍。在实际应用中，根据业务需求合理选择和配置这些注解，能够更高效地完成开发任务。