千家信息网

怎么利用Spring Boot和JPA创建GraphQL API

发表于:2025-01-16 作者:千家信息网编辑
千家信息网最后更新 2025年01月16日,本篇内容主要讲解"怎么利用Spring Boot和JPA创建GraphQL API",感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习"怎么利用Spring Bo
千家信息网最后更新 2025年01月16日怎么利用Spring Boot和JPA创建GraphQL API

本篇内容主要讲解"怎么利用Spring Boot和JPA创建GraphQL API",感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习"怎么利用Spring Boot和JPA创建GraphQL API"吧!

一、生成项目

https://start.spring.io/并生成一个项目,不要忘记添加Spring Web、H2数据库和Spring DATA JPA依赖项。

1. 添加依赖项

要启用GraphQL的使用,请在下面添加这两个依赖项。

  com.graphql-java  graphql-spring-boot-starter  5.0.2  com.graphql-java  graphql-java-tools  5.2.4

二、Schema

GraphQL模式定义了通过API可用的数据点。模式描述了数据类型及其关系,以及可用的操作,例如检索数据的查询和创建、更新和删除数据的突变。

在resources文件夹中,创建一个扩展名为".graphqls"的文件,全名为"location.graphqls"。

//Define the Entity attributetype Location { id: ID! name: String! address: String!}type Query { findAllLocations: [Location]!}type Mutation { newLocation(name: String!, address: String) : Location! deleteLocation(id:ID!) : Boolean updateLocationName(newName: String!, id:ID!) : Location!}

"!"表示该字段为必填字段。

三、Entity 和 Repository

现在创建一个名为Location的实体。该位置应该有三个属性:idnameaddress,如模式中所述。当然,也会产生 Getters, Setters, 和 Constrictors。

然后,在本例中,存储库只使用CrudRepository,并扩展位置实体。

//imports...public interface LocationRepository extends CrudRepository {}

四、Queries & Exceptions

1. 查询

查询允许我们检索数据。每个查询可以有一个特定的对象,它完全基于查询中指定的字段返回,您可以添加或删除字段以匹配您需要的确切数据,以适合您的特定用例。

创建一个解析器包,然后添加一个实现GraphQLQueryResolver的新查询类,并添加@Component注释。我们只需要添加之前在location中输入的location.graphqls

//imports...@Componentpublic class Query implements GraphQLQueryResolver {    private LocationRepository locationRepository;    public Query(LocationRepository locationRepository) {        this.locationRepository = locationRepository;    }    public Iterable findAllLocations() {        return locationRepository.findAll();    }}

2. Mutator

GraphQL中的Mutator允许它更新存储在服务器上的数据。与查询不同,创建、更新或删除等Mutator会改变数据。

现在创建一个mutator包,然后添加一个实现GraphQLMutationResolver和添加@Component注释的新类Mutation。另外,添加我们之前输入的location.graphqls

//imports...@Componentpublic class Mutation implements GraphQLMutationResolver {    private LocationRepository locationRepository;    public Mutation(LocationRepository locationRepository) {        this.locationRepository = locationRepository;    }    public Location newLocation(String name, String address) {        Location location = new Location(name, address);        locationRepository.save(location);        return location;    }    public boolean deleteLocation(Long id) {        locationRepository.deleteById(id);        return true;    }    public Location updateLocationName(String newName, Long id) {        Optional optionalLocation =                locationRepository.findById(id);        if(optionalLocation.isPresent()) {            Location location = optionalLocation.get();            location.setName(newName);            locationRepository.save(location);            return location;        } else {            throw new LocationNotFoundException("Location Not Found", id);        }    }

3. Exceptions

创建一个异常包,然后添加一个新的类LocationNotFoundException,该类扩展RuntimeException并实现GraphQLError

//imports...public class LocationNotFoundException extends RuntimeException implements GraphQLError {    private Map extensions = new HashMap<>();    public LocationNotFoundException(String message, Long invalidLocationId) {        super(message);        extensions.put("invalidLocationId", invalidLocationId);    }    @Override    public List getLocations() {        return null;    }    @Override    public Map getExtensions() {        return extensions;    }    @Override    public ErrorType getErrorType() {        return ErrorType.DataFetchingException;    }

到此,相信大家对"怎么利用Spring Boot和JPA创建GraphQL API"有了更深的了解,不妨来实际操作一番吧!这里是网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

0