[Java] JSch를 사용하여 리눅스 명령어 원격 전송하기

자동화 스크립트를 작성하는 건 중요한 일이다. 이게 없으면 DB 실행/백업과 같이 일상적이면서 반복되는 작업들을 일일이 해줘야하기 때문이다. 리눅스 서버에 접속하고... 로그인하고... 명령어 하나하나를 한 땀 한 땀 넣어주는 일은 꽤나 고된 일이다. 이런 일들을 자동화하기 위해 일반적으로 쉘 스크립트를 작성하는 경우가 많지만, 혹시 자바 개발자들을 위한 라이브러리는 없을까 찾아보니 JSch를 사용하면 된다고 한다. 

---

JSch 란?

리눅스 서버를 원격으로 관리할 때, SSH (Secure Shell)를 통해 명령어를 전송하는 것이 일반적이다. 이를 위해 윈도우에서는 파이썬의 paramiko 라이브러리를 사용할 수 있는데, 자바에도 JSch라는 비슷한 라이브러리가 있다.  JSch는 자바로 구현된 SSH2 프로토콜 라이브러리로, 해당 라이브러리를 사용하면 자바 애플리케이션에서 리눅스 서버로 명령어를 전송하고 실행할 수 있다. 

---

기본 코드 예제

아래는 JSch를 사용하여 리눅스 서버에 접속하고 간단한 명령어를 실행하는 예제이다. 명령어를 실행한 후 결과를 출력하는 부분에서 클라이언트 쪽 stream과 서버 쪽 stream 둘 다 대기상태로 들어가 데드락에 걸릴 수 있으니 구현할 때 주의해야한다. 

import java.io.*;
import com.jcraft.jsch.*;

public class JschExample {

	public static void main(String[] args) {
		final String host = "xxx.xxx.xxx.xxx";
		final String username = "yourUsername";
		final String password = "yourPassword";
		final int port = 22;
		Session session = null;

		try {
			JSch jsch = new JSch();
			session = jsch.getSession(username, host, port);
			session.setPassword(password);
			session.setConfig("StrictHostKeyChecking", "no"); // 호스트 키 검증 비활성화 (보안상 권장되지 않음, 테스트용으로만)
			session.connect();
			executeCommand(session, "ls -l");
		} catch (Exception e) {
			// error handling
		} finally {
			if (session != null) {
				session.disconnect();
			}
		}
	}

	private static void executeCommand(Session session, String command) throws IOException, JSchException {
		ChannelExec channel = (ChannelExec) session.openChannel("exec"); // sftp 채널 생성
		channel.setCommand(command);

		ByteArrayOutputStream outputBuffer = new ByteArrayOutputStream();
		ByteArrayOutputStream errorBuffer = new ByteArrayOutputStream();

		InputStream in = channel.getInputStream();
		InputStream err = channel.getExtInputStream();

		channel.connect();

		byte[] temp = new byte[1024];
		while (true) {
			while (in.available() > 0) {
				int i = in.read(temp, 0, 1024);
				if (i < 0) {
					break;
				}
				outputBuffer.write(temp, 0, i);
			}

			while (err.available() > 0) {
				int i = err.read(temp, 0, 1024);
				if (i < 0) {
					break;
				}
				errorBuffer.write(temp, 0, i);
			}

			if (channel.isClosed()) {
				if ((in.available() > 0) || err.available() > 0) {
					continue;
				}
				System.out.println("exit-status: " + channel.getExitStatus());
				break;
			}
			try {
				Thread.sleep(1000);
			} catch (Exception e) {
			}
		}

		String output = outputBuffer.toString("UTF-8");
		String error = errorBuffer.toString("UTF-8");

		if (output != null && output.length() > 0)
			System.out.println("output: " + output);
		if (error != null && error.length() > 0)
			System.out.println("error: " + error);

		channel.disconnect();
	}
}

 

 

공식 예제는 http://www.jcraft.com/jsch/examples/Exec.java.html ← 여기서 더 찾아볼 수 있다.