当前位置：首页 > article >正文

SpringBoot如何在使用MongoRepository时启用@Created

article 2024/9/22 4:31:49

欢迎转载，但请标明出处和引用本文地址

1. 需要的依赖

对于 MongoDB，首先要确保你引入了以下依赖：Spring Boot Starter Data MongoDB

这是用于支持 MongoDB 的基础依赖，替代 spring-boot-starter-data-jpa。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

2. 启用 MongoDB 审计功能

与 JPA 类似，MongoDB 审计也需要启用。首先，在主类上启用 MongoDB 的审计功能。

在主类上添加 @EnableMongoAuditing

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.mongodb.config.EnableMongoAuditing;

@SpringBootApplication
@EnableMongoAuditing // 重要
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3. 实体类上添加审计注解

与 JPA 类似，在 MongoDB 的实体类（通常是文档类）中添加 @CreatedBy 和 @CreatedDate 注解。

import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.CreatedBy;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedBy;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.mongodb.core.mapping.Document;

import java.time.LocalDateTime;

@Document  // 指定 MongoDB 中的集合名称
public class MyDocument {

    @Id
    private String id;

    @CreatedBy
    private String createBy;

    @CreatedDate
    private LocalDateTime createdDate;

    @LastModifiedBy
    private String lastModifiedBy;

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;

    // getter 和 setter
}

4. 配置 `AuditorAware` Bean

MongoDB 审计同样需要一个 AuditorAware 实现，用来提供当前用户信息。以下是基于 Spring Security 的实现：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.domain.AuditorAware;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;

import java.util.Optional;

@Configuration
public class AuditConfig {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return new AuditorAwareImpl();
    }

    public static class AuditorAwareImpl implements AuditorAware<String> {

        @Override
        public Optional<String> getCurrentAuditor() {
            Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
            if (authentication == null || !authentication.isAuthenticated()) {
                return Optional.empty();
            }
            return Optional.of(((UserDetails)authentication.getPrincipal()).getUsername()); // 返回当前用户名
        }
    }
}

5. 配置 MongoDB 连接

还需要在 application.properties（或 application.yml）文件中配置 MongoDB 连接。

5. 检查配置（重要）

如果你创建实体类时，例如上文所提到的MyDocument实体类时进行了如下操作

MyDocument myDocument = new MyDocument();
// 主动的添加id
myDocument.setId(ObjectId.get().toString());
// ... 其它的赋值操作

// 存储数据库
MyDocumentMongoRepository.save(myDocument);


// 样例代码，在csdn中编辑，有错误请指出

MongoRepository的相关代码进行添加审计注解时，会判断你这个类是不是新创建的类，如果时新创建的类，会执行注入

@CreatedBy @LastModifiedBy @CreatedDate @LastModifiedDate 所

标注的的参数，如果不是新创建的类则只会注入

@LastModifiedBy @LastModifiedDate

这两个更新标识的参数，

相关代码判断是否是新创建的类的条件是：判断@Id所标识的字段是否为 NULL（或者你没有使用@Id标识，但是有一个String或者ObjectId类型的id字段，会默认是id）

以上是实践所得出，如有出入可能是springboot版本不一致导致，请根据自己实际情况测试

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.8</version>
        <relativePath/>
    </parent>

查看全文

http://www.kler.cn/news/314186.html