spring boot实现软删除的示例代码

package com.mengyunzhi.springbootsamplecode.softdelete.entity;

import javax.persistence.MappedSuperclass;

@MappedSuperclass
public abstract class BaseEntity {
  private Boolean deleted = false;
  // setter and getter
}

package com.mengyunzhi.springbootsamplecode.softdelete.entity;

import org.hibernate.annotations.SQLDelete;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

/**
 * 班级
 */
@Entity
@SQLDelete(sql = "update `klass` set deleted = 1 where id = ?")
public class Klass extends BaseEntity {
  @Id
  @GeneratedValue
  private Long id;
  private String name;
  // setter and getter
}

@Entity
@SQLDelete(sql = "update `klass_test` set deleted = 1 where id = ?")
@Where(clause = "deleted = false")
public class KlassTest extends BaseEntity {
  @Id @GeneratedValue
  private Long id;
  private String name;
}

package com.mengyunzhi.springbootsamplecode.softdelete.core;


import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.NoRepositoryBean;

import javax.transaction.Transactional;
import java.util.Optional;

/**
 * 应用软删除
 * 默认的@Where(clause = "deleted = 0")会导致hibernate内部进行关联查询时，发生ObjectNotFound的异常
 * 在此重新定义接口
 * 参考：https://stackoverflow.com/questions/19323557/handling-soft-deletes-with-spring-jpa/22202469
 * @author 河北工业大学 梦云智软件开发团队
 */
@NoRepositoryBean
public interface SoftDeleteCrudRepository<T, ID> extends CrudRepository<T, ID> {
  @Override
  @Transactional
  @Query("select e from #{#entityName} e where e.id = ?1 and e.deleted = false")
  Optional<T> findById(ID id);

  @Override
  @Transactional
  default boolean existsById(ID id) {
    return findById(id).isPresent();
  }

  @Override
  @Transactional
  @Query("select e from #{#entityName} e where e.deleted = false")
  Iterable<T> findAll();

  @Override
  @Transactional
  @Query("select e from #{#entityName} e where e.id in ?1 and e.deleted = false")
  Iterable<T> findAllById(Iterable<ID> ids);

  @Override
  @Transactional
  @Query("select count(e) from #{#entityName} e where e.deleted = false")
  long count();
}

/**
 * 班级
 * @author panjie
 */
public interface KlassRepository extends SoftDeleteCrudRepository<Klass, Long>{
}

public interface KlassTestRepository extends SoftDeleteCrudRepository<KlassTest, Long> {
}

public interface TeacherRepository extends CrudRepository<Teacher, Long> {
}

package com.mengyunzhi.springbootsamplecode.softdelete.repository;

import com.mengyunzhi.springbootsamplecode.softdelete.entity.Klass;
import com.mengyunzhi.springbootsamplecode.softdelete.entity.KlassTest;
import com.mengyunzhi.springbootsamplecode.softdelete.entity.Teacher;
import org.assertj.core.api.Assertions;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.orm.jpa.JpaObjectRetrievalFailureException;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;
import java.util.Optional;


/**
 * @author panjie
 */
@SpringBootTest
@RunWith(SpringRunner.class)
public class TeacherRepositoryTest {
  private final static Logger logger = LoggerFactory.getLogger(TeacherRepositoryTest.class);
  @Autowired KlassRepository klassRepository;
  @Autowired KlassTestRepository klassTestRepository;
  @Autowired TeacherRepository teacherRepository;

  @Test
  public void findById() {
    logger.info("新建一个有Klass和KlassTest的教师");
    Klass klass = new Klass();
    klassRepository.save(klass);
    KlassTest klassTest = new KlassTest();
    klassTestRepository.save(klassTest);
    Teacher teacher = new Teacher();
    teacher.setKlass(klass);
    teacher.setKlassTest(klassTest);
    teacherRepository.save(teacher);

    logger.info("查找教师，断言查找了实体，并且不发生异常");
    Optional<Teacher> teacherOptional = teacherRepository.findById(teacher.getId());
    Assertions.assertThat(teacherOptional.get()).isNotNull();


    logger.info("删除关联的Klass, 再查找教师实体，断言查找到了实体，不发生异常。断言教师实体中，仍然存在已经删除的Klass实体");
    klassRepository.deleteById(klass.getId());
    teacherOptional = teacherRepository.findById(teacher.getId());
    Assertions.assertThat(teacherOptional.get()).isNotNull();
    Assertions.assertThat(teacherOptional.get().getKlass().getId()).isEqualTo(klass.getId());

    logger.info("查找教师列表，不发生异常。断言教师实体中，存在已删除的Klass实体记录");
    List<Teacher> teacherList = (List<Teacher>) teacherRepository.findAll();
    for (Teacher teacher1 : teacherList) {
      Assertions.assertThat(teacher1.getKlass().getId()).isEqualTo(klass.getId());
    }

    logger.info("删除关联的KlassTest，再查找教师实体, 断言找到了删除的klassTest");
    klassTestRepository.deleteById(klassTest.getId());
    teacherOptional = teacherRepository.findById(teacher.getId());
    Assertions.assertThat(teacherOptional.get()).isNotNull();
    Assertions.assertThat(teacherOptional.get().getKlassTest().getId()).isEqualTo(klassTest.getId());

    logger.info("再查找教师列表，断言将发生JpaObjectRetrievalFailureException(EntityNotFound 异常被捕获后，封装抛出)异常");
    Boolean catchException = false;
    try {
      teacherRepository.findAll();
    } catch (JpaObjectRetrievalFailureException e) {
      catchException = true;
    }
    Assertions.assertThat(catchException).isTrue();
  }

}