利用Spring Boot和JPA创建GraphQL API

 更新时间:2022年04月27日 11:31:16   作者: sofia   
这篇文章主要介绍了利用Spring Boot和JPA创建GraphQL API,GraphQL既是API查询语言,也是使用当前数据执行这些查询的运行时,下文更多相关内容介绍需要的小伙伴可以参考一下

前言:

GraphQL既是API查询语言,也是使用当前数据执行这些查询的运行时。GraphQL让客户能够准确地要求他们所需要的东西,仅此而已,使API随着时间的推移更容易发展,并通过提供API中数据的清晰易懂的描述,支持强大的开发工具。

在本文中,我们将创建一个简单的机场位置应用程序。

一、生成项目

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

1. 添加依赖项

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

<dependency>
  <groupId>com.<a href="https://javakk.com/tag/graphql" rel="external nofollow"  target="_blank" >graphql</a>-java</groupId>
  <artifactId>graphql-spring-boot-starter</artifactId>
  <version>5.0.2</version>
</dependency>
<dependency>
  <groupId>com.graphql-java</groupId>
  <artifactId>graphql-java-tools</artifactId>
  <version>5.2.4</version>
</dependency>

二、Schema

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

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

//Define the Entity attribute
type 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<Location, Long> {
}

四、Queries & Exceptions

1. 查询

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

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

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

2. Mutator

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

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

//imports...
@Component
public 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<Location> 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<String, Object> extensions = new HashMap<>();
    public LocationNotFoundException(String message, Long invalidLocationId) {
        super(message);
        extensions.put("invalidLocationId", invalidLocationId);
    }
    @Override
    public List<SourceLocation> getLocations() {
        return null;
    }
    @Override
    public Map<String, Object> getExtensions() {
        return extensions;
    }
    @Override
    public ErrorType getErrorType() {
        return ErrorType.DataFetchingException;
    }

现在GraphQL API已经可以使用了!

到此这篇关于利用Spring Boot和JPA创建GraphQL API的文章就介绍到这了,更多相关创建GraphQL API内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java开发微信分享到朋友圈功能

    java开发微信分享到朋友圈功能

    这篇文章主要为大家详细介绍了java开发微信发送给朋友和分享到朋友圈功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-07-07
  • ReentrantLock可重入锁原理解析

    ReentrantLock可重入锁原理解析

    这篇文章主要为大家介绍了ReentrantLock可重入锁原理解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • IntelliJ IDEA 中git的使用图文教程

    IntelliJ IDEA 中git的使用图文教程

    本文通过图文并茂的形式给大家介绍了IntelliJ IDEA 中git的使用,非常不错,具有参考借鉴价值,需要的朋友参考下吧
    2018-02-02
  • 详解springmvc 中controller与jsp传值

    详解springmvc 中controller与jsp传值

    本篇文章主要介绍了springmvc 中controller与jsp传值,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • 使用Feign消费服务时POST/GET请求方式详解

    使用Feign消费服务时POST/GET请求方式详解

    这篇文章主要介绍了使用Feign消费服务时POST/GET请求方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • Java实现的RSA加密解密算法示例

    Java实现的RSA加密解密算法示例

    这篇文章主要介绍了Java实现的RSA加密解密算法,结合实例形式分析了java RAS加密解密算法的相关实现技巧,需要的朋友可以参考下
    2018-01-01
  • 解决IDEA 2020.1版本 maven Test命令出现导包错误的问题

    解决IDEA 2020.1版本 maven Test命令出现导包错误的问题

    这篇文章主要介绍了IDEA 2020.1版本 maven Test命令出现导包错误的问题及解决方法,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • java获取客服端信息的方法(系统,浏览器等)

    java获取客服端信息的方法(系统,浏览器等)

    下面小编就为大家带来一篇java获取客服端信息的方法(系统,浏览器等)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • Java中的静态内部类详解及代码示例

    Java中的静态内部类详解及代码示例

    这篇文章主要介绍了Java中的静态内部类详解及代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-10-10
  • Java中的Null到底是什么

    Java中的Null到底是什么

    null是没有地址,""是有地址但是里面的内容是空的,好比做饭 null说明连锅都没有 而""则是有锅没米,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,下面我们来详细学习一下它吧
    2019-06-06

最新评论