[마인크래프트 플러그인만들기] MySQL 연동하기

 

안녕하세요 뿀입니다!

 

이번에는 다른 부분에서도 유용하게 사용할법한 데이터베이스 연동 플러그인 만드는 방법을 가져왔습니다.

 

그럼 시작합니다!!!

 

 

---

 

목표

DB에 Player 정보 저장

 

설명

서버에 데이터를 저장하는 방법에는 여러가지 방법이 있습니다. 변수에 저장하는 방법도 있지만, 이전에 이 방법을 사용해서 서버가 실행되고있는 동안만 변수에 저장되고, 서버 종료 시 삭제된다는 점을 알게되었습니다. 우리는 서버가 종료되도 데이터를 저장할 수 있는 방법을 사용해야하는데 해당 방법으로는 크게 2가지가 있습니다.

첫 번째 방법은 텍스트 파일에 저장하는 것 입니다. CVS, JSON, YAML 등을 사용할 수 있으며 텍스트 파일에 저장하면 단순하고, 파일 복사/붙여넣기를 통해 쉽게 이동할 수 있습니다. 데이터 양이 적은 경우에는 이 방법도 괜찮지만, 데이터가 많아지면 데이터를 검색하고 처리할 때에 성능이 떨어지며 보안에 그렇게 좋은 편은 아닙니다.

두 번째 방법은 데이터베이스에 저장하는 방법입니다. MySQL, SQLite, MongoDB 등의 DBMS(DataBase Management System)가 있으며 데이터를 효율적으로 검색할 수 있고, 데이터가 많아져도 텍스트 파일에 저장하는 것보다 데이터 처리할 때의 성능이 괜찮은 편입니다. 하지만 텍스트 파일에 비해 리소스가 많이 사용되는 편이며 플러그인에 데이터베이스를 위한 별도의 설정을 해주어야합니다.

이 글에서는 데이터베이스 관리 시스템 중 하나인 MySQL을 사용해 플러그인을 만들어보겠습니다.

 

방법

1. MySQL 설정

MySQL 다운로드는 아래 링크 참고해주세요.

MySQL 8.0 다운로드 & 설치하기

1-1. MySQL 실행

명령프롬프트를 실행하고, mysql -u root -p 를 입력해 로그인해줍니다.

1-2. User, Database 생성 / 권한 부여

데이터베이스와 해당 데이터베이스를 사용할 유저를 생성합니다.

저는 유저 ppyom과 test_plugin_1 데이터베이스를 생성했습니다.

- 유저 생성 create user 사용자아이디 identified by 비밀번호; - 데이터베이스 생성 create database 데이터베이스이름; - 유저에게 데이터베이스에 관련된 모든 권한 부여 grant all privileges on 데이터베이스이름.* to 사용자아이디;

 

모두 생성했다면 exit를 입력해 나가주세요.

 

1-3. Player Table 생성

우선 mysql -u 사용자아이디 -p 데이터베이스이름을 입력해 위에서 만든 사용자/데이터베이스로 로그인한 다음 아래 코드를 입력해 테이블을 생성해줍니다.

create table user (
    id          varchar(36) not null comment '플레이어 UUID',
    username    varchar(16) not null comment '플레이어 마인크래프트 닉네임',
    displayName varchar(16) null comment '플레이어가 지정한 닉네임',
    constraint player_pk
        primary key (id)
);

 

2. DBConnection을 관리하는 플러그인 생성

이 플러그인은 다른 작업은 하지 않고 오로지 데이터베이스의 연결/해제 역할만 하는 플러그인입니다.

프로젝트 생성은 아래 링크 참고해주세요.

[마인크래프트 플러그인만들기] IntelliJ 없이 프로젝트 구성하기

 

[마인크래프트 플러그인만들기] IntelliJ 사용해서 프로젝트 구성하기

2-1. build.gradle에 maven 배포를 위한 코드 추가

다른 프로젝트에서 사용하기 위해 maven local repository에 배포할 수 있도록 만들 것 입니다.

build.gradle에 아래 코드를 추가해줍니다.

plugins {     id 'java'     id 'maven-publish' // maven publish를 위한 플러그인 } ... // publish를 위한 코드 publishing {     publications {         mavenJava(MavenPublication) {             from components.java         }     } }

이렇게 수정하고 [Gradle 변경 내용 로드]를 클릭하면 Gradle 메뉴의 Tasks에 publishing이 추가됩니다. publishing - publishToMavenLocal을 더블클릭하면 maven local repository에 배포됩니다. 배포된 파일은 C:\Users\사용자이름\.m2\repository\...패키지... 에서 확인할 수 있습니다.

2-2. 데이터베이스 설정파일 작성

서버 폴더 - plugins에 프로젝트 이름과 같은 폴더를 생성하고, 해당 폴더에 config.yml 파일을 생성합니다.

database:
  url: jdbc:mysql://localhost:3306/데이터베이스이름
  username: 사용자아이디
  password: 비밀번호

2-3. 코드 작성

플러그인과 서버가 연결될 때 데이터베이스를 연결하고, 서버와 연결이 해제된다면 연결을 해제하면 됩니다.

플러그인이 서버에 연결될 때 실행되는 메서드인 onEnable에서 데이터베이스와 연결하는 코드를 작성하고, 서버와 연결이 해제될 때 실행되는 메서드인 onDisable에서 데이터베이스 연결을 해제하는 코드를 작성하면 되는 것으로 아주 간단하게 처리할 수 있습니다.

package com.ppyom;

import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import org.bukkit.plugin.java.JavaPlugin;

import java.io.File;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public final class DBConnectionPlugin extends JavaPlugin {
    private Connection connection;

    @Override
    public void onEnable() {
        getLogger().info("DBConnectionPlugin onEnable");
        saveDefaultConfig();
        connectDatabase();
    }

    @Override
    public void onDisable() {
        getLogger().info("DBConnectionPlugin onDisable");
        if(connection != null) {
            try {
                connection.close();
                getLogger().info("데이터베이스 연결이 해제되었습니다.");
            } catch (SQLException e) {
                getLogger().severe(e.getMessage());
            }
        }
    }

    private void connectDatabase() {
        File configFile = new File(getDataFolder(), "config.yml");
        FileConfiguration config = YamlConfiguration.loadConfiguration(configFile);

        String url = config.getString("database.url");
        String username = config.getString("database.username");
        String password = config.getString("database.password");

        try {
            connection = DriverManager.getConnection(url, username, password);
            getLogger().info("데이터베이스 연결에 성공했습니다.");
        } catch(SQLException e) {
            e.getStackTrace();
            getLogger().severe("데이터베이스 연결에 실패했습니다.");
        }
    }

    public Connection getConnection() {
        return connection;
    }
}

위 코드를 작성한 다음 maven local repository에 배포(publishToMavenLocal)하고 빌드(build)합니다.

빌드된 플러그인을 서버에 적용시키면 아래와 같이 연결에 성공했다는 로그를 볼 수 있습니다.

 

3. PlayerInformationPlugin 수정

이전 프로젝트에서 이어서 진행합니다.

[마인크래프트 플러그인] 닉네임 변경 플러그인 만들기

3-1. 프로젝트 설정파일 수정

plugin.yml

다른 플러그인에 의존해야할 때에는 해당 플러그인에 의존한다는 내용을 별도로 알려주어야합니다.

아래 내용을 추가해주세요.

...

depend:
  - DBConnectionPlugin

...

 

build.gradle

코드에서 사용하기 위해서 gradle에 dependency추가가 필요합니다.

아래 내용을 추가해주세요.

... repositories {     mavenCentral()     mavenLocal()     ... } dependencies {     compileOnly "io.papermc.paper:paper-api:1.20.4-R0.1-SNAPSHOT"     compileOnly "본인의패키지.DBConnectionPlugin:1.0-SNAPSHOT" } ...

 

3-2. 코드 수정

UserDao.java

UserDao 입니다.

기존에 변수를 사용해서 작성했던 부분을 DB를 사용하도록 변경했습니다.

package com.ppyom.user.dao;

import com.ppyom.common.dao.Dao;
import com.ppyom.user.domain.User;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.*;

public class UserDao implements Dao<User> {
	private final Connection connection;

	public UserDao(Connection connection) {
		this.connection = connection;
	}

	@Override
	public User findById(String id) {
		String query = "SELECT * FROM user WHERE id = ?";
		try (PreparedStatement statement = connection.prepareStatement(query)) {
			statement.setString(1, id.toString());
			ResultSet resultSet = statement.executeQuery();
			if(resultSet.next()) {
				return extractUser(resultSet);
			}
		} catch (SQLException e) {
			//
		}
		return null;
	}

	@Override
	public List<User> findAll() {
		List<User> users = new ArrayList<>();
		String query = "SELECT * FROM user";
		try (PreparedStatement statement = connection.prepareStatement(query)) {
			ResultSet resultSet = statement.executeQuery();
			if(resultSet.next()) {
				users.add(extractUser(resultSet));
			}
		} catch (SQLException e) {
			//
		}
		return users;
	}

	@Override
	public void create(User user) {
		String query = "INSERT INTO user (id, username) VALUES (?, ?)";
		try (PreparedStatement statement = connection.prepareStatement(query)) {
			statement.setString(1, user.getId().toString());
			statement.setString(2, user.getUsername());
			statement.executeUpdate();
		} catch (SQLException e) {
			//
		}
	}

	@Override
	public void update(User user) {
		String query = "UPDATE user SET username = ?, displayName = ? WHERE id = ?";
		try (PreparedStatement statement = connection.prepareStatement(query)) {
			statement.setString(1, user.getUsername());
			statement.setString(2, user.getDisplayName());
			statement.setString(3, user.getId().toString());
			statement.executeUpdate();
		} catch (SQLException e) {
			//
		}
	}

	@Override
	public void delete(User user) {
		String query = "DELETE FROM user WHERE id = ?";
		try (PreparedStatement statement = connection.prepareStatement(query)) {
			statement.setString(1, user.getId().toString());
			statement.executeUpdate();
		} catch (SQLException e) {
			//
		}
	}

	private User extractUser(ResultSet resultSet) throws SQLException {
		UUID id = UUID.fromString(resultSet.getString("id"));
		String username = resultSet.getString("username");
		String displayName = resultSet.getString("displayName");
		return new User(id, username, displayName);
	}
}

 

PlayerInformationPlugin.java

메인 플러그인입니다.

DBConnectionPlugin을 가져다가 사용합니다.

기존에 이벤트, 커맨드를 등록하던 부분을 모두 합쳐서 initPlugin 메서드로 통합해서 사용합니다.

package com.ppyom;

import com.ppyom.user.command.DisplayNameCommand;
import com.ppyom.user.dao.UserDao;
import com.ppyom.user.event.JoinListener;
import com.ppyom.user.service.UserService;
import org.bukkit.Bukkit;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.PluginCommand;
import org.bukkit.event.Listener;
import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.java.JavaPlugin;

import java.sql.Connection;

public final class PlayerInformationPlugin extends JavaPlugin {
    @Override
    public void onEnable() {
        getLogger().info("PlayerInformationPlugin onEnable");
        initPlugin();
    }

    @Override
    public void onDisable() {
        getLogger().info("PlayerInformationPlugin onDisable");
    }

    private void initPlugin() {
        Plugin plugin = Bukkit.getPluginManager().getPlugin("DBConnectionPlugin");
        
        if(plugin instanceof DBConnectionPlugin dbConnectionPlugin) {
            Connection connection = dbConnectionPlugin.getConnection();
            UserDao userDao = new UserDao(connection);
            UserService userService = new UserService(userDao);

            // 이벤트 등록
            registerEvent(new JoinListener(userService));

            // 커맨드 등록
            registerCommand("display-name", new DisplayNameCommand(userService));
        } else {
            getLogger().severe("DBConnectionPlugin이 없거나 실행되지 않았습니다.");
            Bukkit.getPluginManager().disablePlugin(this);
        }
    }

    private void registerEvent(Listener listener) {
        getServer().getPluginManager().registerEvents(listener, this);
    }

    private void registerCommand(String name, CommandExecutor commandExecutor) {
        PluginCommand pluginCommand = getServer().getPluginCommand(name);
        if(pluginCommand != null) {
            pluginCommand.setExecutor(commandExecutor);
        }
    }
}

 

 

결과

위 사진처럼 닉네임을 변경하고, 서버를 재시작해도 닉네임이 그대로 남아있는 것을 확인할 수 있습니다!!!

 

 

---

 

 

잘 읽어보셨나요?

 

다음에도 유용한 플러그인 만드는 방법을 가져와보겠습니다!

궁금한 점 댓글로 남겨주시면 최대한 열심히 답변해드리겠습니다!!

이후 다른것들 보고싶으면 댓글 남겨주세요~~!!

 

뿀이였습니다! 읽어주셔서 감사합니다!