From 051ee49b2a414b7fc11c4968704ea71f55efbdf3 Mon Sep 17 00:00:00 2001
From: blinkfox <chenjiayin1990@163.com>
Date: Mon, 28 Mar 2022 00:55:18 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E4=BA=86=20ActiveRecord=20?=
 =?UTF-8?q?=E6=A8=A1=E5=BC=8F=E7=9A=84=E9=83=A8=E5=88=86=E4=BB=A3=E7=A0=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../com/blinkfox/fenix/ar/FenixModel.java     | 161 ++++++++++++++++++
 1 file changed, 161 insertions(+)
 create mode 100644 src/main/java/com/blinkfox/fenix/ar/FenixModel.java

diff --git a/src/main/java/com/blinkfox/fenix/ar/FenixModel.java b/src/main/java/com/blinkfox/fenix/ar/FenixModel.java
new file mode 100644
index 0000000..428b89c
--- /dev/null
+++ b/src/main/java/com/blinkfox/fenix/ar/FenixModel.java
@@ -0,0 +1,161 @@
+package com.blinkfox.fenix.ar;
+
+import com.blinkfox.fenix.exception.FenixException;
+import com.blinkfox.fenix.helper.StringHelper;
+import com.blinkfox.fenix.jpa.FenixJpaRepository;
+import java.util.Optional;
+import lombok.Setter;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.transaction.annotation.Transactional;
+
+/**
+ * Fenix 提供的 ActiveRecord 模式的基础 Model 类. TODO 待进一步开发...
+ *
+ * @param <T> 实体类的的泛型参数
+ * @param <ID> 主键 ID
+ * @author blinkfox on 2022-03-27.
+ * @since v2.7.0
+ */
+public abstract class FenixModel<T, ID> {
+
+    /**
+     * Spring Bean 的应用上下文，用于动态获取 Spring Data JPA 中各种实体所对应的 Repository 的 Bean 实例.
+     */
+    @Setter
+    private static ApplicationContext applicationContext;
+
+    /**
+     * 用来存储本实体类所对应的 Repository 对象，便于后续快速获取，本对象会在第一次使用时动态获取并存储.
+     */
+    private CrudRepository<T, ID> repository;
+
+    /**
+     * 获取实体类的 ID 值.
+     *
+     * @return ID
+     */
+    abstract ID getEntityId();
+
+    /**
+     * 获取本实体类所对应的 Repository 对象在 Spring 中 Bean 的名称.
+     *
+     * <p>Fenix 默认会根据实体类'首字母小写的类名称' + 'Repository' 后缀来拼接 Bean 的名称。
+     * 如果你实际的 Bean 名称不是这样的，你可以在实体类中，重写本方法来提供你真正定义的 Repository 的 Spring Bean 名称。</p>
+     *
+     * @return Repository 对象在 Spring 中 Bean 的名称
+     */
+    public String getRepositoryBeanName() {
+        String entityName = this.getClass().getSimpleName();
+        return entityName.substring(0, 1).toLowerCase() + entityName.substring(1) + "Repository";
+    }
+
+    /**
+     * 获取本实体类所对应的 Repository 的类名称.
+     *
+     * @return Repository 的类名
+     */
+    private String getRepositoryClassName() {
+        return this.getClass().getSimpleName() + "Repository";
+    }
+
+    /**
+     * 获取本实体类所对应的 Repository 对象
+     *
+     * @return 基本的 CrudRepository 对象
+     */
+    public CrudRepository<T, ID> getRepository() {
+        if (this.repository != null) {
+            return this.repository;
+        }
+
+        // 如果之前没有初始化过 repository 的对象实例，就同步并再次检查判断或初始化 repository 的对象实例.
+        synchronized (this) {
+            if (this.repository == null) {
+                this.initCheckAndSetRepository();
+            }
+            return this.repository;
+        }
+    }
+
+    /**
+     * 初始化检查并初始化本实体类所对应的 repository 的对象实例.
+     */
+    @SuppressWarnings("unchecked")
+    private void initCheckAndSetRepository() {
+        // 尝试判断 Spring 容器中是否存在本实体类所对应的 Repository 的 Bean.
+        String repositoryBeanName = this.getRepositoryBeanName();
+        if (!applicationContext.containsBean(repositoryBeanName)) {
+            throw new NoSuchBeanDefinitionException(StringHelper.format("【Fenix 异常】获取实体类【{}】所对应的 "
+                            + "Spring Data JPA 的 Repository Bean【{}】的实例为 Null，请先定义该实体类的 Repository "
+                            + "接口【{}】，并标注【@Repository】注解。", this.getClass().getName(), repositoryBeanName,
+                    this.getRepositoryClassName()));
+        }
+
+        // 获取 repositoryBean，并判断是否是 Repository.
+        Object repositoryBean = applicationContext.getBean(repositoryBeanName);
+        if (repositoryBean instanceof CrudRepository) {
+            this.repository = (CrudRepository<T, ID>) repositoryBean;
+        } else {
+            throw new NoSuchBeanDefinitionException(StringHelper.format("【Fenix 异常】获取到的实体类【{}】"
+                            + "所对应的 Spring Data JPA 的 Repository Bean【{}】的实例不是真正的 CrudRepository 接口或子接口。",
+                    this.getClass().getName(), repositoryBeanName));
+        }
+    }
+
+    /**
+     * 获取本实体类所对应的 {@link FenixJpaRepository} 的对象实例.
+     *
+     * <p>注意:要能真正获取到 {@link FenixJpaRepository} 的对象实例，你需要确保你实体类所对应的 Repository 接口
+     * 是继承了 {@link FenixJpaRepository} 接口的，否则会抛出 {@link FenixException} 异常.</p>
+     *
+     * @return 本实体类的 FenixJpaRepository 对象实例
+     */
+    public FenixJpaRepository<T, ID> getFenixJpaRepository() {
+        CrudRepository<T, ID> crudRepository = this.getRepository();
+        if (crudRepository instanceof FenixJpaRepository) {
+            return (FenixJpaRepository<T, ID>) crudRepository;
+        }
+        throw new FenixException("【Fenix 异常】未获取到本实体类所对应的 FenixJpaRepository 的对象实例，请确保你实体类所对应的 "
+                + "Repository 接口是继承了 FenixJpaRepository 接口的！");
+    }
+
+    /**
+     * 保存本实体对象.
+     *
+     * @return 保存后的对象
+     */
+    @Transactional
+    @SuppressWarnings("unchecked")
+    public T save() {
+        return this.getRepository().save((T) this);
+    }
+
+    /**
+     * 保存本实体对象.
+     *
+     * @return 保存后的对象
+     */
+    @Transactional
+    public <S extends T> Iterable<S> saveAll(Iterable<S> entities) {
+        return this.getRepository().saveAll(entities);
+    }
+
+    /**
+     * 根据本实体对象的 ID 查找数据库中的完整的实体对象记录信息.
+     */
+    public Optional<T> findById() {
+        return this.getRepository().findById(this.getEntityId());
+    }
+
+    /**
+     * 删除本实体对象.
+     */
+    @Transactional
+    @SuppressWarnings("unchecked")
+    public void delete() {
+        this.getRepository().delete((T) this);
+    }
+
+}