작성일 댓글 남기기

GraphQL의 데이터베이스 연동

데이터베이스와의 연동은 GraphQL의 리졸버에서 데이터베이스 요청을 처리하는 방식으로 이루어집니다. 이를 통해 클라이언트가 GraphQL 쿼리나 뮤테이션을 통해 데이터를 요청하거나 수정할 수 있습니다. 이번에는 Node.js 환경에서 MongoDBPostgreSQL 같은 데이터베이스와 GraphQL을 연동하는 방법을 예시로 설명할게요.

1. GraphQL 서버와 데이터베이스 연동 기본 개념

GraphQL 서버는 데이터 요청을 처리할 때 **리졸버(Resolver)**를 사용합니다. 리졸버는 클라이언트의 요청을 받아 데이터베이스에 질의(query)하거나, 데이터를 수정하는 역할을 합니다.

기본 흐름:

  1. 클라이언트는 GraphQL 쿼리나 뮤테이션을 서버에 보냅니다.
  2. GraphQL 서버의 리졸버는 해당 요청을 처리하고, 데이터베이스에 연결해 데이터를 조회하거나 변경합니다.
  3. 데이터베이스는 리졸버의 요청에 따라 데이터를 반환합니다.
  4. 서버는 클라이언트에 요청한 데이터를 반환합니다.

2. MongoDB와의 연동

MongoDB는 NoSQL 데이터베이스 중 하나로, JavaScript 객체처럼 데이터를 저장하는 유연한 구조를 가지고 있습니다. Mongoose라는 ORM(Object Relational Mapping)을 통해 Node.js와 쉽게 연동할 수 있습니다.

1) 환경 설정

  1. 패키지 설치:bash코드 복사npm install mongoose npm install graphql express express-graphql
  2. MongoDB와 연결 설정: 먼저 MongoDB에 연결하고, Mongoose를 이용해 데이터를 처리하는 간단한 예제를 작성해보겠습니다.
const mongoose = require('mongoose');
const express = require('express');
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');

// MongoDB 연결
mongoose.connect('mongodb://localhost:27017/mydatabase', {
useNewUrlParser: true,
useUnifiedTopology: true
});

// Mongoose 스키마 정의
const userSchema = new mongoose.Schema({
name: String,
email: String
});

const User = mongoose.model('User', userSchema);

// GraphQL 스키마 정의
const schema = buildSchema(`
type User {
id: ID!
name: String!
email: String!
}

type Query {
users: [User]
user(id: ID!): User
}

type Mutation {
addUser(name: String!, email: String!): User
}
`);

// GraphQL 리졸버 정의
const root = {
users: async () => {
return await User.find();
},
user: async ({ id }) => {
return await User.findById(id);
},
addUser: async ({ name, email }) => {
const newUser = new User({ name, email });
await newUser.save();
return newUser;
}
};

// Express 설정
const app = express();
app.use('/graphql', graphqlHTTP({
schema: schema,
rootValue: root,
graphiql: true
}));

app.listen(4000, () => {
console.log('Server is running on http://localhost:4000/graphql');
});

2) 설명

  • Mongoose 스키마: userSchema는 MongoDB에 저장될 사용자의 구조를 정의합니다. 이름과 이메일을 필드로 가지는 사용자 데이터를 정의하였습니다.
  • 리졸버: users 리졸버는 모든 사용자 목록을 반환하고, addUser는 새로운 사용자를 추가한 후 해당 데이터를 반환합니다.
  • MongoDB와 연동: 리졸버에서 Mongoose의 find()findById()와 같은 메서드를 사용해 데이터를 데이터베이스에서 조회하고, save()로 새 데이터를 저장합니다.

3) 실행 및 테스트

서버를 실행하고 브라우저에서 http://localhost:4000/graphql에 접속하면 GraphiQL을 통해 데이터를 조회하거나 추가할 수 있습니다.

예를 들어, 사용자 목록을 가져오는 쿼리:

query {
users {
id
name
email
}
}

새로운 사용자를 추가하는 뮤테이션:

mutation {
addUser(name: "Alice", email: "[email protected]") {
id
name
email
}
}

이렇게 하면 MongoDB에 데이터가 저장되고, 조회할 수 있습니다.

3. PostgreSQL과의 연동

PostgreSQLSQL 기반의 관계형 데이터베이스입니다. Sequelize라는 ORM을 사용하여 Node.js와 PostgreSQL을 쉽게 연동할 수 있습니다.

1) 환경 설정

  1. 패키지 설치:
    npm install sequelize pg pg-hstore npm install graphql express express-graphql
  2. PostgreSQL과 연결 설정: PostgreSQL에 연결한 후, Sequelize를 이용해 테이블과 모델을 정의합니다.
const { Sequelize, DataTypes } = require('sequelize');
const express = require('express');
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');

// PostgreSQL 연결
const sequelize = new Sequelize('postgres://username:password@localhost:5432/mydatabase');

// Sequelize 모델 정의
const User = sequelize.define('User', {
name: {
type: DataTypes.STRING,
allowNull: false
},
email: {
type: DataTypes.STRING,
allowNull: false
}
}, {});

// 데이터베이스 초기화
sequelize.sync();

// GraphQL 스키마 정의
const schema = buildSchema(`
type User {
id: ID!
name: String!
email: String!
}

type Query {
users: [User]
user(id: ID!): User
}

type Mutation {
addUser(name: String!, email: String!): User
}
`);

// GraphQL 리졸버 정의
const root = {
users: async () => {
return await User.findAll();
},
user: async ({ id }) => {
return await User.findByPk(id);
},
addUser: async ({ name, email }) => {
return await User.create({ name, email });
}
};

// Express 설정
const app = express();
app.use('/graphql', graphqlHTTP({
schema: schema,
rootValue: root,
graphiql: true
}));

app.listen(4000, () => {
console.log('Server is running on http://localhost:4000/graphql');
});

2) 설명

  • Sequelize 모델: User 모델은 PostgreSQL의 users 테이블과 연동됩니다. 각 사용자는 nameemail 필드를 가지고 있습니다.
  • 리졸버: users 리졸버는 모든 사용자 목록을 반환하고, addUser 리졸버는 새로운 사용자를 추가합니다.
  • PostgreSQL 연동: 리졸버에서 Sequelize의 findAll(), findByPk() 메서드를 사용해 데이터를 조회하고, create()를 사용해 새 데이터를 생성합니다.

3) 실행 및 테스트

서버를 실행하고 브라우저에서 GraphiQL을 통해 데이터를 조회하거나 추가할 수 있습니다. 예시는 MongoDB와 동일하게 쿼리나 뮤테이션을 실행하면 됩니다.

4. 데이터베이스 선택 및 연동의 주요 포인트

1) 데이터베이스 선택

  • MongoDB: 데이터 구조가 자주 바뀌거나, 비정형 데이터를 다룰 때 NoSQL 데이터베이스인 MongoDB가 유리합니다.
  • PostgreSQL: 데이터 구조가 고정적이거나 관계형 데이터가 필요할 경우, SQL 기반의 PostgreSQL이 적합합니다.

2) GraphQL과의 연동

  • GraphQL은 데이터베이스에 독립적인 쿼리 언어입니다. 이를 통해 데이터를 가져오거나 수정할 때, GraphQL 자체는 데이터베이스의 종류에 상관없이 사용될 수 있습니다.
  • 각 데이터베이스와 연동할 때, 적절한 ORM이나 라이브러리를 사용하여 GraphQL의 리졸버와 데이터베이스 간의 연결을 처리하면 됩니다.

작성일 댓글 남기기

GraphQL의 고급 기능들(서브스크립션, 데이터 최적화, 인증 등)

1. 서브스크립션(Subscription)

서브스크립션실시간 데이터 업데이트를 처리하는 GraphQL의 기능입니다. 주로 실시간 채팅, 주식 가격 업데이트, 알림 시스템 등 실시간으로 데이터가 변동되는 애플리케이션에서 사용됩니다.

기본 개념

서브스크립션은 클라이언트가 서버와 실시간 연결을 유지하면서, 데이터가 변경될 때마다 자동으로 업데이트를 받을 수 있도록 하는 방식입니다. GraphQL에서는 이를 WebSocket과 같은 프로토콜을 통해 구현합니다.

예시

예를 들어, 새로운 메시지가 추가될 때마다 클라이언트가 실시간으로 업데이트를 받을 수 있도록 서브스크립션을 정의할 수 있습니다.

스키마 예시:

type Subscription {
messageAdded: Message
}

type Message {
id: ID!
content: String!
author: String!
}

서브스크립션 리졸버:

const { PubSub } = require('graphql-subscriptions');
const pubsub = new PubSub();

const resolvers = {
Subscription: {
messageAdded: {
subscribe: () => pubsub.asyncIterator(['MESSAGE_ADDED'])
}
},
Mutation: {
addMessage: (parent, { content, author }) => {
const message = { id: Date.now(), content, author };
pubsub.publish('MESSAGE_ADDED', { messageAdded: message });
return message;
}
}
};

이 예시에서 PubSub을 사용하여 새 메시지가 추가될 때마다 구독 중인 클라이언트에게 이를 실시간으로 전송할 수 있습니다. 클라이언트 측에서는 Apollo Client의 subscribe 메서드를 통해 실시간 데이터를 받을 수 있습니다.

클라이언트에서 서브스크립션 사용

import { gql, useSubscription } from '@apollo/client';

const MESSAGE_ADDED = gql`
subscription {
messageAdded {
id
content
author
}
}
`;

function Messages() {
const { data, loading } = useSubscription(MESSAGE_ADDED);

if (loading) return <p>Loading...</p>;
return <p>New message: {data.messageAdded.content}</p>;
}

2. 데이터 최적화 (Batching, Caching, 그리고 DataLoader)

GraphQL에서는 데이터 전송을 효율화하고 최적화하는 여러 가지 방법이 있습니다. REST API와 마찬가지로, GraphQL에서도 데이터 최적화는 성능에 중요한 영향을 미칩니다.

1) Batching과 DataLoader

데이터를 효율적으로 가져오기 위한 도구로 DataLoader를 사용할 수 있습니다. DataLoader는 여러 개의 GraphQL 쿼리를 배치(batch) 처리하여 N+1 문제를 해결하는 데 유용합니다.

N+1 문제란, 데이터를 요청할 때 동일한 데이터베이스 쿼리가 여러 번 발생하는 성능 이슈를 말합니다. 예를 들어, 10명의 사용자를 가져올 때, 10번의 데이터베이스 쿼리가 실행될 수 있는데, DataLoader를 사용하면 이를 하나의 쿼리로 묶어 처리할 수 있습니다.

DataLoader 예시:

const DataLoader = require('dataloader');

const userLoader = new DataLoader(async (keys) => {
const users = await UserModel.find({ _id: { $in: keys } });
return keys.map(key => users.find(user => user.id === key));
});

const resolvers = {
Query: {
user: (parent, { id }, context) => {
return context.userLoader.load(id); // DataLoader 사용
}
}
};

효과:

  • 여러 번의 데이터베이스 쿼리를 하나로 묶어 처리해 성능을 최적화.
  • 요청당 쿼리의 수를 줄여 서버의 부하 감소.

2) 캐싱(Caching)

GraphQL에서는 데이터 요청 시 불필요한 중복 요청을 피하기 위해 캐싱 전략을 적용할 수 있습니다. 클라이언트 측에서는 Apollo Client와 같은 라이브러리에서 캐싱 기능을 자동으로 지원하며, 서버 측에서는 Redis 같은 캐시 서버를 사용할 수 있습니다.

Apollo Client 캐싱: Apollo Client는 쿼리 결과를 자동으로 캐싱하고, 같은 쿼리가 반복되면 네트워크 요청을 보내지 않고 캐시된 데이터를 사용합니다.

import { ApolloClient, InMemoryCache } from '@apollo/client';

const client = new ApolloClient({
uri: 'http://localhost:4000/graphql',
cache: new InMemoryCache()
});

이처럼 Apollo Client에서는 캐시가 기본적으로 설정되어 있으며, 데이터 요청이 있을 때마다 캐시를 먼저 확인하고, 필요한 경우에만 서버로 요청을 보냅니다.

3. 인증(Authentication) 및 권한 관리(Authorization)

GraphQL에서는 클라이언트가 요청하는 데이터가 민감할 수 있기 때문에, 인증권한 관리가 중요합니다. 이를 위해 보통 **JWT (JSON Web Token)**이나 세션 기반 인증을 사용합니다.

1) JWT를 이용한 인증

클라이언트가 서버에 요청을 보낼 때, JWT 토큰을 HTTP 헤더에 포함하여 인증을 수행할 수 있습니다.

JWT 토큰을 헤더에 포함:

import { ApolloClient, InMemoryCache, createHttpLink } from '@apollo/client';
import { setContext } from '@apollo/client/link/context';

const httpLink = createHttpLink({
uri: 'http://localhost:4000/graphql'
});

const authLink = setContext((_, { headers }) => {
const token = localStorage.getItem('authToken');
return {
headers: {
...headers,
authorization: token ? `Bearer ${token}` : '',
}
};
});

const client = new ApolloClient({
link: authLink.concat(httpLink),
cache: new InMemoryCache()
});

위의 예시에서 Apollo Client는 요청을 보내기 전, JWT 토큰을 자동으로 HTTP 헤더에 추가합니다. 서버 측에서는 이 토큰을 검증한 후 클라이언트의 권한을 확인할 수 있습니다.

2) 서버에서 권한 관리

서버 측에서는 인증된 사용자만 특정 쿼리나 뮤테이션에 접근할 수 있도록 리졸버에서 인증을 확인할 수 있습니다.

권한 관리 예시:

javascript코드 복사const resolvers = {
  Query: {
    secretData: (parent, args, context) => {
      if (!context.user) {
        throw new Error('Not authenticated');
      }
      return "This is secret data!";
    }
  }
};

Context 객체를 사용해 요청을 처리하기 전에 사용자가 인증되었는지 확인합니다. 인증되지 않은 사용자는 해당 쿼리나 뮤테이션에 접근할 수 없습니다.

결론

  • 서브스크립션: 실시간 데이터 업데이트를 위해 사용되며, WebSocket을 통해 서버와 실시간 연결을 유지합니다.
  • 데이터 최적화: DataLoader를 사용해 데이터베이스 쿼리 효율을 높이고, Apollo Client 같은 도구를 통해 캐싱을 구현할 수 있습니다.
  • 인증 및 권한 관리: JWT 토큰을 사용해 클라이언트를 인증하고, 권한이 있는 사용자만 데이터에 접근할 수 있도록 합니다.