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

 

안녕하세요 뿀입니다!

 

블로그 방문자 검색어를 구경하다가 SQLite를 검색해서 접속하신 분이 계신걸 알게되었습니다.

원래 다른 글을 작성하고있다가 혹시라도!! 필요한 분이 더 계실 수도 있다는 생각에 이 글을 먼저 작성합니다!!

 

그럼 시작합니다!!!

 

 

---

이전에 작성한 코드에서 이어집니다.

코드는 아래 링크들 참고해주세요!!

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

 

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

 

 

 

목표

SQLite를 사용할 수 있도록 플러그인 수정

 

설명

저번에 MySQL을 연동하는 플러그인을 만들었습니다. 하지만 MySQL은 별도로 설치해야되고 설정 및 관리가 (비교적) 복잡한 편입니다. 대규모 어플리케이션의 경우는 MySQL을 사용하는 것도 좋지만, 일반 소규모 어플리케이션이라면 가볍게 사용할 수 있는 SQLite를 사용하는 것도 좋습니다.

SQLite는 MySQL과 다르게 별도로 설치하지 않아도 되고, 별도로 설정해야하는게 없습니다. 가볍고 "소규모"에서 매우 빠른 성능을 보입니다. 하지만 많은 연결을 처리하기 어렵기 때문에 여러 사용자가 동시에 write 작업을 수행하면 성능 저하가 발생할 수 있습니다. 또한 보안 기능이 제한적이라서 보안이 중요한 어플리케이션은 사용을 지양하는 것이 좋습니다.

그럼 바로 만들어보겠습니다!

 

방법

!! 제가 한 방법이 무조건 정답은 아니라는 것은 언제나 기억하고 계셨으면 좋겠습니다. !!

!! 혹시라도 더 좋은 방법이 있다면 저한테도.. 댓글로..!! 알려주시면 감사합니다 !!

서버 폴더 - plugins/플러그인폴더/config.yml 수정

기존에 MySQL만 사용할 수 있게 작성해둔 config 파일을 수정합니다.

이전과는 다르게 앞으로는 어떤 데이터베이스를 사용할 것인지 알려주기 위해 type을 작성합니다.

아래 코드를 작성해주세요.

database:
  type: sqlite
  url: jdbc:sqlite:plugins/DBConnectionPlugin/database.db

 

DBConnectionPlugin 수정

이제 MySQL 뿐만 아니라 SQLite도 지원하기 위한 코드를 작성해보겠습니다.

입력받은 데이터베이스 타입은 DBConnectionPlugin 뿐만 아니라 데이터베이스를 사용하는 플러그인에서 필요하기 때문에 변수로 저장해두고 getConnection처럼 가져가서 사용할 수 있는 메서드를 만들어줍니다.

...
private String databaseType;
...
public String getDatabaseType() {
    return databaseType;
}
...

데이터베이스 타입을 사용해 입력받은 데이터베이스에 맞게 처리하도록 작성해보겠습니다.

만약 databaseType이 우리가 지금 만드는 플러그인이 지원하지 않는 타입이라면 플러그인을 중지시키도록 설정해두었습니다.

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

    String url = config.getString("database.url");
    databaseType = config.getString("database.type");

    if(url == null) {
        getLogger().severe("Database URL은 null일 수 없습니다.");
        getServer().getPluginManager().disablePlugin(this);
        return;
    }

    try {
        if("mysql".equalsIgnoreCase(databaseType)) {
            connection = DriverManager.getConnection(
                    url,
                    config.getString("database.username"),
                    config.getString("database.password")
            );
        } else if("sqlite".equalsIgnoreCase(databaseType)) {
            connection = DriverManager.getConnection(url);
        } else {
            getLogger().severe("지원하지 않는 데이터베이스 타입입니다.");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }

        getLogger().info("데이터베이스 연결에 성공했습니다.");
        getLogger().info(String.format("Database Type = %s", databaseType));
    } catch(SQLException e) {
        e.getStackTrace();
        getLogger().severe("데이터베이스 연결에 실패했습니다.");
    }
}

최종 코드는 아래와 같습니다.

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;
    private String databaseType;

    @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");
        databaseType = config.getString("database.type");

        if(url == null) {
            getLogger().severe("Database URL은 null일 수 없습니다.");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }

        try {
            if("mysql".equalsIgnoreCase(databaseType)) {
                connection = DriverManager.getConnection(
                        url,
                        config.getString("database.username"),
                        config.getString("database.password")
                );
            } else if("sqlite".equalsIgnoreCase(databaseType)) {
                connection = DriverManager.getConnection(url);
            } else {
                getLogger().severe("지원하지 않는 데이터베이스 타입입니다.");
                getServer().getPluginManager().disablePlugin(this);
                return;
            }

            getLogger().info("데이터베이스 연결에 성공했습니다.");
            getLogger().info(String.format("Database Type = %s", databaseType));
        } catch(SQLException e) {
            e.getStackTrace();
            getLogger().severe("데이터베이스 연결에 실패했습니다.");
        }
    }

    public Connection getConnection() {
        return connection;
    }

    public String getDatabaseType() {
        return databaseType;
    }
}

 

PlayerInformationPlugin 수정

저번 프로젝트에서는 MySQL에서 미리 테이블을 만들었습니다. 보통 서버 개발자는 이렇게 하는 것으로 알고있습니다. 하지만 SQLite는 대체로 클라이언트측 어플리케이션에서 주로 사용하기 때문에 소스코드에서 테이블을 생성하는 경우가 많습니다. 따로 다른 프로그램을 사용해서 테이블을 생성하는 것보다 소스코드에 테이블 생성하는 쿼리를 작성하는게 좋을 것 같아 MySQL과 SQLite 모두 소스코드에 작성해보겠습니다.

저는 테이블을 만드는 메서드를 별도의 클래스인 UserTableCreator를 만들었습니다.

package com.ppyom.user.dao;

import com.ppyom.PlayerInformationPlugin;
import org.bukkit.plugin.Plugin;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;

public class UserTableCreator {
	private final Connection connection;
	private final String databaseType;
	public UserTableCreator(Connection connection, String databaseType) {
		this.connection = connection;
		this.databaseType = databaseType;
	}

	public void create() {
		String query;
		
		try (Statement statement = connection.createStatement()) {
			if("mysql".equalsIgnoreCase(databaseType)) {
				query = "CREATE TABLE IF NOT EXISTS user (" +
								"id varchar(36) primary key," +
								"username varchar(16) not null," +
								"displayName varchar(16)" +
						");";
			} else if("sqlite".equalsIgnoreCase(databaseType)) {
				query = "CREATE TABLE IF NOT EXISTS user (" +
								"id text primary key," +
								"username text not null," +
								"displayName text" +
						");";
			} else { // 지원하지 않는 데이터베이스 타입인 경우
				throw new IllegalArgumentException(databaseType);
			}
			statement.execute(query);
		} catch (SQLException | IllegalArgumentException e) {
			Plugin plugin = PlayerInformationPlugin.getPlugin(PlayerInformationPlugin.class);
			if(e instanceof SQLException) { // SQLException
				plugin.getLogger().severe("데이터베이스 처리 중 오류가 발생했습니다.");
			} else { // IllegalArgumentException
				plugin.getLogger().severe(String.format("해당 데이터베이스 타입을 찾을 수 없습니다. %s", e.getMessage()));
				plugin.getServer().getPluginManager().disablePlugin(plugin);
			}
		}
	}
}

그리고 해당 클래스를 메인 클래스에서 사용하면 됩니다.

// TableCreator를 생성하고, create 메서드 실행
UserTableCreator tableCreator = new UserTableCreator(
        connection,
        dbConnectionPlugin.getDatabaseType()
);
tableCreator.create();

최종 메인 클래스 코드는 아래와 같습니다.

package com.ppyom;

import com.ppyom.user.command.DisplayNameCommand;
import com.ppyom.user.dao.UserDao;
import com.ppyom.user.dao.UserTableCreator;
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();
            UserTableCreator tableCreator = new UserTableCreator(
                    connection,
                    dbConnectionPlugin.getDatabaseType()
            );
            tableCreator.create();

            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);
        }
    }
}

 

결과

데이터베이스만 변경했는데 기존에 작성했던 기능이 정상적으로 작동하는 것을 확인할 수 있습니다.

 

 

---

 

 

잘 읽어보셨나요?

 

다음에도 유용한 글 작성해보겠습니다!!

궁금하거나 더 필요하신거 있으면 댓글 남겨주세요~!~!

 

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