Spring PetClinic GraphQL 项目教程

Spring PetClinic GraphQL 项目教程

1. 项目目录结构及介绍

Spring PetClinic GraphQL 项目是一个使用 Spring Boot 和 GraphQL 的示例应用程序。以下是项目的目录结构及其简要介绍：

spring-petclinic-graphql/
├── .github/             # GitHub 工作流文件
├── backend/             # 后端代码目录
├── frontend/            # 前端代码目录
├── e2e-tests/           # 端到端测试目录
├── .gitattributes/      # Git 属性文件
├── .gitignore/          # Git 忽略文件
├── .gitpod.yml          # GitPod 配置文件
├── LICENCE              # 项目许可证文件
├── build-local.sh        # 本地构建脚本
├── docker-compose-petclinic.yml # Docker Compose 配置文件
├── docker-compose.yml    # Docker Compose 配置文件
├── gitpod.png           # GitPod 相关图片
├── graphiql.png         # GraphiQL 相关图片
├── graphql.config.yml   # GraphQL 配置文件
├── login.http           # 登录 HTTP 请求示例
├── mvnw                 # Maven 包装器脚本
├── mvnw.cmd             # Maven 包装器脚本（Windows 版本）
├── petclinic-ui.png      # PetClinic UI 图片
├── pom.xml              # Maven 项目文件
├── readme.md            # 项目自述文件
└── screenshot-gitpod-intellij.png # GitPod IntelliJ 截图

backend/

后端代码目录，包含了 Spring Boot 应用程序的所有 Java 代码。

frontend/

前端代码目录，包含了使用 React 和 Apollo GraphQL 构建的单页应用程序。

e2e-tests/

端到端测试目录，包含了使用 Playwright 进行的端到端测试。

.gitattributes/

定义了 Git 的一些属性配置。

.gitignore/

定义了 Git 忽略的文件和目录。

.gitpod.yml

GitPod 配置文件，用于在 GitPod 环境中设置项目。

LICENCE

项目使用的许可证文件。

build-local.sh

本地构建脚本，用于运行和构建项目。

docker-compose-petclinic.yml

Docker Compose 配置文件，用于定义和运行多容器 Docker 应用程序。

docker-compose.yml

Docker Compose 配置文件，用于定义和运行多容器 Docker 应用程序。

gitpod.png

GitPod 相关的图片文件。

graphiql.png

GraphiQL 相关的图片文件。

graphql.config.yml

GraphQL 配置文件，用于配置 GraphQL 工具链。

login.http

登录 HTTP 请求示例。

mvnw

Maven 包装器脚本，用于方便运行 Maven 命令。

mvnw.cmd

Maven 包装器脚本（Windows 版本）。

petclinic-ui.png

PetClinic UI 的图片文件。

pom.xml

Maven 项目文件，定义了项目的依赖和构建配置。

readme.md

项目自述文件，包含了项目的描述和使用说明。

screenshot-gitpod-intellij.png

GitPod IntelliJ 的截图文件。

2. 项目的启动文件介绍

项目的启动文件位于 backend/ 目录下，主要的启动类是 PetClinicApplication.java。

package org.springframework.samples.petclinic;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class PetClinicApplication {

    public static void main(String[] args) {
        SpringApplication.run(PetClinicApplication.class, args);
    }
}

这个类使用了 @SpringBootApplication 注解，它是一个方便的注解，包含了 @Configuration，@EnableAutoConfiguration 和 @ComponentScan。main 方法通过调用 SpringApplication.run 方法来启动 Spring Boot 应用程序。

3. 项目的配置文件介绍

项目的配置文件主要位于 backend/src/main/resources/ 目录下，以下是一些重要的配置文件：

application.properties

这是 Spring Boot 的标准配置文件，用于定义应用程序的配置属性。

# Example application.properties
server.port=9977
spring.datasource.url=jdbc:postgresql://localhost:5432/petclinic
spring.datasource.username=petclinic
spring.datasource.password=petclinic
spring.jpa.hibernate.ddl-auto=update

application.yml

这个文件通常用于定义更复杂的配置，使用 YAML 格式。

# Example application.yml
spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/petclinic
    username: petclinic
    password: petclinic
  jpa:
    hibernate:
      ddl-auto: update

这些配置文件定义了应用程序的基本设置，例如服务器端口、数据库连接信息等。在实际项目中，你可能需要根据你的开发环境或生产环境修改这些配置。