diff --git a/docs/zh_CN/custom-repository.md b/docs/zh_CN/custom-repository.md index f585f2fa1..ee7abfb6e 100644 --- a/docs/zh_CN/custom-repository.md +++ b/docs/zh_CN/custom-repository.md @@ -8,140 +8,61 @@ 有几种方法可以创建自定义存储库。 - - [扩展了标准存储库的定制存储库](#扩展了标准存储库的定制存储库) - - [扩展了标准AbstractRepository的自定义存储库](#扩展了标准AbstractRepository的自定义存储库) - - [没有扩展的自定义存储库](#没有扩展的自定义存储库) - - [在事务中使用自定义存储库或为什么自定义存储库不能是服务](#在事务中使用自定义存储库或为什么自定义存储库不能是服务) +- [自定义存储库](#自定义存储库) + - [如何自定义存储库](#如何自定义存储库) + - [在事务中使用自定义存储库](#在事务中使用自定义存储库) -## 扩展了标准存储库的定制存储库 +## 如何自定义存储库 -创建自定义 repository 的第一种方法是扩展`Repository`。 -例如: +常见的做法是将一个实体的存储库实例赋值给一个变量导出,然后在你的应用中使用它,例如: -```typescript -import { EntityRepository, Repository } from "typeorm"; -import { User } from "../entity/User"; +```ts +// user.repository.ts +export const UserRepository = dataSource.getRepository(User) -@EntityRepository(User) -export class UserRepository extends Repository { - findByName(firstName: string, lastName: string) { - return this.findOne({ firstName, lastName }); - } +// user.controller.ts +export class UserController { + users() { + return UserRepository.find() + } } ``` -然后你可以这样使用它: +你可以使用 `Repository` 类中的 `.extend` 方法来扩展 `UserRepository` 的功能: ```typescript -import { getCustomRepository } from "typeorm"; -import { UserRepository } from "./repository/UserRepository"; +// user.repository.ts +export const UserRepository = dataSource.getRepository(User).extend({ + findByName(firstName: string, lastName: string) { + return this.createQueryBuilder("user") + .where("user.firstName = :firstName", { firstName }) + .andWhere("user.lastName = :lastName", { lastName }) + .getMany() + }, +}) -const userRepository = getCustomRepository(UserRepository); // 或connection.getCustomRepository或manager.getCustomRepository() -const user = userRepository.create(); // 和 const user = new User();一样 -user.firstName = "Timber"; -user.lastName = "Saw"; -await userRepository.save(user); - -const timber = await userRepository.findByName("Timber", "Saw"); -``` - -如你所见,你也可以使用`getCustomRepository` 获取 repository, -并且可以访问在其中创建的任何方法以及标准实体 repository 中的任何方法。 - -## 扩展了标准AbstractRepository的自定义存储库 - -创建自定义 repository 的第二种方法是扩展`AbstractRepository`: - -```typescript -import { EntityRepository, AbstractRepository } from "typeorm"; -import { User } from "../entity/User"; - -@EntityRepository(User) -export class UserRepository extends AbstractRepository { - createAndSave(firstName: string, lastName: string) { - const user = new User(); - user.firstName = firstName; - user.lastName = lastName; - return this.manager.save(user); - } - - findByName(firstName: string, lastName: string) { - return this.repository.findOne({ firstName, lastName }); - } +// user.controller.ts +export class UserController { + users() { + return UserRepository.findByName("Timber", "Saw") + } } ``` -然后你可以这样使用它: +## 在事务中使用自定义存储库 + +每个事务有自己的执行作用域:它们有自己的执行器、实体管理器和储存库。 +这就是使用全局的(数据源的)实体管理器和存储库在事务中并不会生效的原因。 +为了确保事务中的操作能够正确地被执行你**必须**使用提供的实体管理器实例及其 `getRepository` 方法。如果需要在事务中使用自定义存储库,你必须使用其提供的实体管理器实例上的 `withRepository` 方法: ```typescript -import { getCustomRepository } from "typeorm"; -import { UserRepository } from "./repository/UserRepository"; +await connection.transaction(async (manager) => { + // 在事务中你必须使用其提供的实体管理器实例, + // 不能使用全局的实体管理器或者存储库, + // 因为这个实体管理器具有排他性和事务性 -const userRepository = getCustomRepository(UserRepository); // or connection.getCustomRepository or manager.getCustomRepository() -await userRepository.createAndSave("Timber", "Saw"); -const timber = await userRepository.findByName("Timber", "Saw"); -``` - -这种类型的存储库与前一个存储库之间的区别在于它没有公开`Repository`所具有的所有方法。 -`AbstractRepository`没有任何公共方法,它只有受保护的方法,比如`manager`和`repository`,你可以在自己的公共方法中使用它们。 -如果你不希望将标准`Repository`所有方法公开给 public,那么扩展`AbstractRepository`将非常有用。 - -## 没有扩展的自定义存储库 - -创建存储库的第三种方法是不扩展任何东西, -但是需要定义一个总是接受实体管理器(entity manager)实例的构造函数: - -```typescript -import { EntityRepository, Repository, EntityManager } from "typeorm"; -import { User } from "../entity/User"; - -@EntityRepository() -export class UserRepository { - constructor(private manager: EntityManager) {} - - createAndSave(firstName: string, lastName: string) { - const user = new User(); - user.firstName = firstName; - user.lastName = lastName; - return this.manager.save(user); - } - - findByName(firstName: string, lastName: string) { - return this.manager.findOne(User, { firstName, lastName }); - } -} -``` - -然后你可以这样使用它: - -```typescript -import { getCustomRepository } from "typeorm"; -import { UserRepository } from "./repository/UserRepository"; - -const userRepository = getCustomRepository(UserRepository); // 或者 connection.getCustomRepository 或者 manager.getCustomRepository() -await userRepository.createAndSave("Timber", "Saw"); -const timber = await userRepository.findByName("Timber", "Saw"); -``` - -这种类型的存储库不会扩展任何东西,你只需要定义一个必须接受`EntityManager`的构造函数。 然后在存储库方法中的任何位置使用它。 -此外,这种类型的存储库不绑定到特定实体,因此你可以使用其中的多个实体进行操作。 - -## 在事务中使用自定义存储库或为什么自定义存储库不能是服务 - -自定义存储库不能是服务,因为应用程序中没有自定义存储库的单个实例(就像常规存储库或实体管理器一样)。 -除了您的应用程序中可能存在多个连接(实体管理器和存储库不同)之外,存储库和管理器在事务中也是不同的。 - -例如: - -```typescript -await connection.transaction(async manager => { - // 在事务中你必须使用事务提供的管理器实例而不能使用全局管理器、存储库或自定义存储库, - // 因为这个管理器是独占的和事务性的, - // 如果让我们自定义存储库作为服务,它的一个"manager"属性应该 是EntityManager的唯一实例,但没有全局的EntityManager实例,并且也不可能有。 - // 这就是为什么自定义管理器特定于每个EntityManager而不能是服务。 - // 这也提供了在事务中使用自定义存储库而不会出现什么问题: - const userRepository = manager.getCustomRepository(UserRepository); // 不要在这里使用全局的getCustomRepository! - await userRepository.createAndSave("Timber", "Saw"); - const timber = await userRepository.findByName("Timber", "Saw"); -}); + const userRepository = manager.withRepository(UserRepository) + await userRepository.createAndSave("Timber", "Saw") + const timber = await userRepository.findByName("Timber", "Saw") +}) ```