docs/framework/versions/0.7.8_cn.md · dearxuecom/apihug.com

---
title: SDK 0.7.8-RELEASE 重大更新
description: 0.7.8-RELEASE 重大更新和迁移步骤
---

[English](./0.7.8.md) | [简体中文](./0.7.8_cn.md)

💁 如果你尚未使用 `ApiHug` 领域实体对象管理(ORM), 那么这次升级暂不会影响你，但最好和官方保持最新统一版本! :-)

最新: <a target="_blank" href="https://search.maven.org/artifact/com.apihug/it-bom"><img src="https://img.shields.io/maven-central/v/com.apihug/it-bom.svg?label=Maven%20Central" /></a>

`0.7.8-RELEASE` 添加功能:

- 将 `Repository` 扩展, 迁移到独立的  `trait` 目录管理, 使代码结构更简单清晰;
- `lite` 模式作为 `stub` 默认编译模式，将使他更迅捷;

![domain design](../../public/image/framework/domain.jpg)

## Repository 迁移

目的:

1. 使 `repository` 更直接简单.
2. 使 `repository` 扩展更方便维护.

举个在你模块  `book-app` 已存在 的 `repository`为例: `com.novel.book.wire.domain.book.repository.BookAuthorRepository`:

**现有逻辑在**:  `book-app\src\main\stub\com\novel\book\wire\domain\book\repository\BookAuthorRepository`:

```java
@Repository
@SuppressWarnings("Duplicates")
public interface BookAuthorRepository
    extends HopeJdbc<BookAuthor>,
        BookJdbcSupport,
        BookAuthorDSL,
        ListCrudRepository<BookAuthor, Long> {

@Derived
  @Query
  Optional<BookAuthor> findByName(final String name);

//Other method
}
```

⚠️⚠️⚠️ 首先保证你的 `@Derived` 已经备份， 在你跑 `stub` 命令前;(如果版本管理，先commit为妙)

因为升级后的 `stub` 只保留纯 `generated`代码, 也就是`stub` 命令后，任何`stub`目录下手动代码都将被清除.

### Step1

跑下本模块的 `stub` 命令， 首先保证你SDK 版本已经被更新到 `0.7.8-RELEASE`+,  `gradle\libs.versions.toml`:

```toml

[versions]
# libraries
apihug = "0.7.8-RELEASE"

```

命令行可以到你项目的 `README.md` 找到:

```shell

./gradlew.bat book-app:clean stub build -x test -x stubTest

```

跑完后你会看到一个新的 `sourceSet`: `book-app\src\main\trait`;

💁‍♀️ 你可能需要到你的 gradle tool window 触发本项目的 `Reload Gradle Project` ，否则可能提醒 `book-app\src\main\trait` 不能被当做 `sourceSet`!

### Step2

1. 手动将 `@Derived` copy 回到 `_BookAuthorRepository`(trait 目录下) & `BookAuthorRepository`(stub 目录)(只有第一次迁移需要，以后只需要在 `_BookAuthorRepository` 编写);
2. 再次启动 `stub` 命令.

从今往后， 所有Repository扩展 `@Derived` 方法, 都在独立 `book-app\src\main\trait` 目录维护：

1. `stub` 命令将你需要融入(trait)的方法（也就是老的`@Derived`方法）合进到运行时的 `BookAuthorRepository` 类
2. 避免 `BookAuthorRepository` 在持续开发中模板和扩展逻辑冲突，保持他的简单和直观.
3. 也很容易维护我们的 repository扩展接口, 这里保持纯的 SQL 逻辑;

### StepX

另外一种迁移方式， 更多手动工作，但是更清晰;

1. 创建目录 `book-app\src\main\trait`
2. 创建 包 package `t.com.novel.book.wire.domain.book.repository`: 原包`com.novel.book.wire.domain.book.repository`加个前缀 `t.`;
3. 添加接口 `interface _BookAuthorRepository` :原接口 `BookAuthorRepository`前缀  `_` (下划线);
4. 添加扩展 `extends BookAuthorRepository` (方便编辑器提示)
5. 将 `BookAuthorRepository` 里所有 `@Derived` 方法拷贝一份到 `_BookAuthorRepository`
6. 执行 `stub` 命令

这个适合有限的 `repository` 类迁移比如少于30个;

---

**真实**项目的目录结构:

## PS

自 SDK 版本`0.8.5-RELEASE`, 引入一种更好控制 `Repository` 扩展方法的方式;

当在 `proto` 添加了新实体后， 运行 `stub` 命令，你将会在 `trait` 得到一个空的 **Repository**:

```java
/**
 * NEVER try to use this class directly, keep it as an interface(default, no public), all body of
 * this interface will be merger to {@link JobEntityRepository} after {@code stub };
 *
 * <p>NEVER try to Overwrite parent {@link JobEntityRepository } or {@link
 * org.springframework.data.repository.ListCrudRepository} 's default method!!
 *
 * @see JobEntityRepository
 * @see com.novel.book.wire.domain.job.JobEntity
 */
interface _JobEntityRepository extends JobEntityRepository {

/** Please put your customized SQL here, any SQL other place will be dropped after merger! */
  interface _DerivedSQL {}
}
```

然后添加一个扩展 DAO 接口:

```java
@Overwrite
default void myDaoApi(){
    
}
```

记得添加 `@Overwrite` ， IDEA 编辑器将提醒你 `Pull method 'myDaoApi' to 'JobEntityRepository'`

按照提示执行，方法将被提升到父接口里面, 采用这个技巧可以避免多跑一次 `stub` 命令;

下次当执行 `stub` 命令时候, 逻辑和代码还是一致的.

## Best Tips

你可以把 `_BookAuthorRepository` 想象成 `BookAuthorRepository`的`伴生类`(虽然有继承关系：方便获得编辑器提示) ;

只是 `ApiHug` 工具链完全帮你处理掉了过程的复杂性!

参考Scala `伴生对象` [Companion objects](https://docs.scala-lang.org/scala3/book/domain-modeling-tools.html#companion-objects);

如果你过程中遇到任何问题，请垂询我们:

![api-hug-contact](../../public/image/apihug-001.gif)

dearxuecom/apihug.com

简介

发行版

贡献者

近期动态

dearxuecom/apihug.com .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

dearxuecom/apihug.com