com.github.fartherp.framework.common.util.DbManager Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017. CK. All rights reserved.
 */

package com.github.fartherp.framework.common.util;

import com.github.fartherp.framework.common.constant.Constant;

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;

/**
 * the database manager tools
 * Author: CK
 * Date: 2015/3/27.
 * @see Connection
 * @see PreparedStatement
 * @see ResultSet
 * @see ResultSetMetaData
 * @see DatabaseMetaData
 */
public class DbManager {

    /**
     * Instantiates a new Db manager.
     */
    public DbManager() {
    }

    /**
     * Instantiates a new Db manager.
     *
     * @param url the url
     * @param user the user
     * @param password the password
     */
    public DbManager(String url, String user, String password) {
        this.url = url;
        this.user = user;
        this.password = password;
    }

    /** default the driveName of mysql */
    private String driveName = Constant.DEFAULT_DRIVE_NAME;

    /** the database url */
    private String url;

    /** the database user */
    private String user;

    /** the database password */
    private String password;

    /**
     * Gets connection.
     *
     * @return the connection
     */
    public Connection getConnection() {
        try {
            Class.forName(this.driveName);
            return DriverManager.getConnection(this.url, this.user, this.password);
        } catch (ClassNotFoundException e) {
            throw new RuntimeException("load database class exception : " + e.getMessage(), e);
        } catch (SQLException e) {
            throw new RuntimeException("get database connection : " + e.getMessage(), e);
        }
    }

    /**
     * Gets prepared statement.
     *
     * @param connection the connection
     * @param sql the sql
     * @return the prepared statement
     */
    public PreparedStatement getPreparedStatement(Connection connection, String sql) {
        try {
            return connection.prepareStatement(sql);
        } catch (SQLException e) {
            throw new RuntimeException("get PrepareStatement exception : " + e.getMessage(), e);
        }
    }

    /**
     * Gets result set.
     *
     * @param preparedStatement the prepared statement
     * @return the result set
     */
    public ResultSet getResultSet(PreparedStatement preparedStatement) {
        try {
            return preparedStatement.executeQuery();
        } catch (SQLException e) {
            throw new RuntimeException("get ResultSet exception : " + e.getMessage(), e);
        }
    }

    /**
     * Get tables message
     * @param connection the connection
     * @param localCatalog the catalog of table
     * @param localSchema the schema of table
     * @param localTableName the table name of table
     * @return the tables message
     */
    public ResultSet getTables(Connection connection, String localCatalog, String localSchema, String localTableName) {
        try {
            return getDatabaseMetaData(connection).getTables(localCatalog, localSchema, localTableName, null);
        } catch (SQLException e) {
            throw new RuntimeException("get tables exception : " + e.getMessage(), e);
        }
    }

    /**
     * Get columns of the specify table.
     * @param connection the connection
     * @param localCatalog the catalog of table
     * @param localSchema the schema of table
     * @param localTableName the table name of table
     * @return the columns
     */
    public ResultSet getColumns(Connection connection, String localCatalog, String localSchema, String localTableName) {
        try {
            return getDatabaseMetaData(connection).getColumns(localCatalog, localSchema, localTableName, null);
        } catch (SQLException e) {
            throw new RuntimeException("get columns exception : " + e.getMessage(), e);
        }
    }

    /**
     * Get primary key of table.
     * @param connection the connection
     * @param localCatalog the catalog of table
     * @param localSchema the schema of table
     * @param localTableName the table name of table
     * @return the primary key
     */
    public ResultSet getPrimaryKeys(Connection connection, String localCatalog, String localSchema, String localTableName) {
        try {
            return getDatabaseMetaData(connection).getPrimaryKeys(localCatalog, localSchema, localTableName);
        } catch (SQLException e) {
            throw new RuntimeException("get primary key exception : " + e.getMessage(), e);
        }
    }

    /**
     * Gets result set meta data.
     *
     * @param resultSet the result set
     * @return the result set meta data
     */
    public ResultSetMetaData getResultSetMetaData(ResultSet resultSet) {
        try {
            return resultSet.getMetaData();
        } catch (SQLException e) {
            throw new RuntimeException("get ResultSetMetaData exception : " + e.getMessage(), e);
        }
    }

    /**
     * Gets database meta data.
     *
     * @param connection the connection
     * @return the database meta data
     */
    public DatabaseMetaData getDatabaseMetaData(Connection connection) {
        try {
            return connection.getMetaData();
        } catch (SQLException e) {
            throw new RuntimeException("get DatabaseMetaData exception : " + e.getMessage(), e);
        }
    }

    /**
     * Close void.
     *
     * @param connection the connection
     * @param preparedStatement the prepared statement
     * @param resultSet the result set
     */
    public void close(Connection connection, PreparedStatement preparedStatement, ResultSet resultSet) {
        if (null != resultSet) {
            try {
                resultSet.close();
            } catch (SQLException e) {
                resultSet = null;
            }
        }
        if (null != preparedStatement) {
            try {
                preparedStatement.close();
            } catch (SQLException e) {
                preparedStatement = null;
            }
        }
        if (null != connection) {
            try {
                connection.close();
            } catch (SQLException e) {
                connection = null;
            }
        }
    }

    /**
     * Close void.
     *
     * @param connection the connection
     */
    public void close(Connection connection) {
        close(connection, null, null);
    }

    /**
     * Close void.
     *
     * @param preparedStatement the prepared statement
     */
    public void close(PreparedStatement preparedStatement) {
        close(null, preparedStatement, null);
    }

    /**
     * Close void.
     *
     * @param resultSet the result set
     */
    public void close(ResultSet resultSet) {
        close(null, null, resultSet);
    }

    /**
     * Gets drive name.
     *
     * @return the drive name
     */
    public String getDriveName() {
        return driveName;
    }

    /**
     * Sets drive name.
     *
     * @param driveName the drive name
     */
    public void setDriveName(String driveName) {
        this.driveName = driveName;
    }

    /**
     * Gets url.
     *
     * @return the url
     */
    public String getUrl() {
        return url;
    }

    /**
     * Sets url.
     *
     * @param url the url
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * Gets user.
     *
     * @return the user
     */
    public String getUser() {
        return user;
    }

    /**
     * Sets user.
     *
     * @param user the user
     */
    public void setUser(String user) {
        this.user = user;
    }

    /**
     * Gets password.
     *
     * @return the password
     */
    public String getPassword() {
        return password;
    }

    /**
     * Sets password.
     *
     * @param password the password
     */
    public void setPassword(String password) {
        this.password = password;
    }
}