五、spring-data-mongodb中Java字段映射注解

Spring Data MongoDB通过注解可以很方便的将Java对象映射到MongoDB文档结构中。常用的字段映射注解主要有:

@Document

注在实体类上，把ava类声明为mongodb的文档，​如果没有设置 collection 值，则对应mongo中和 Java 类名相同的 collection​,​如果设置了 collection 值，则对应mongo中对应的 collection​

​示例​

@Document(collection="db_test") 
public class test{
}

说明：如果没有文档注解，则使用java类名test作为文档名

@Id

表示该字段为文档的id,MongoDB中_id字段。

​示例​

public class test{ 
   @Id
   private String id;
}

@Transient

表示该属性不会被存到数据库（ORM框架将忽略该属性）。

​示例​

class test{
    @Transient
    private String ignoreField;
}

@Field:

表示该字段为文档的普通字段,可以通过name指定存储在MongoDB中的key。如果没有指定name,默认使用Java字段名作为key。
​
示例​:

public class test{ 
   
   @Field("userName")
   private String name;
}

@Version:

表示该字段为文档的版本号字段,可以用于乐观锁。映射到MongoDB的__v字段。
注意使用Long，并非long类型字段。
​
示例​:

public class test{ 
  	@Field("version")
	@Version
	private Long version ;
}

@CreatedDate:

表示该字段为文档的创建日期字段,会自动填充插入文档时的日期。映射到MongoDB的创建日期字段。
​
示例​:

public class test{ 
    @CreatedDate
    private Long createdAt;

    @CreatedDate
    private Date createdDate;
}

@LastModifiedDate:

表示该字段为文档的最后修改日期字段,会自动填充更新文档时的日期。映射到MongoDB的最后修改日期字段。​

示例​:

public class test{ 
    @LastModifiedDate
    private Long updatedAt;
    
    @LastModifiedDate
    private Date modifiedAt;
}

@Indexed:

表示为该字段创建索引,可以通过name指定索引名(默认使用字段名),unique指定是否唯一索引。

示例​:

public class test{ 
   @Index(unique=true)
   private String id;
}

@CompoundIndex:

表示为多个字段创建复合索引。

示例​:

@CompoundIndexes({
    @CompoundIndex(name = "test_", def = "{'userName': 1, 'age': -1}")
})
public class test{ 
   	@Id
  	private String id;

	private String userName;

	private String age;
}

@DBRef:

表示该字段为文档之间的引用关系,包含数据库名和集合名。

示例​:

public class test{ 
    @DBRef
    private List<Try> tries;
}

  通过这些注解,我们可以很方便的将Java对象模型映射到MongoDB文档结构,实现对象文档映射(Object Document Mapping)。

上一章：四、Springboot连接mongodb