Java 操作 Linux 命令行

古城微笑少年丶 2024-03-26 23:18 59阅读 0赞

为了能够展示出服务器指定目录下所有的文件(Jenkins 自动化编译后产生),并提供下载 copy 功能,需要引入第三方依赖进行操作。

**一、引入依赖 ganymed**

<dependency>
        <groupId>ch.ethz.ganymed</groupId>
        <artifactId>ganymed-ssh2</artifactId>
        <version>build210</version>
    </dependency>

**二、工具类 LinuxUtil**

@Component
    @Slf4j
    public class LinuxUtil {
        /** 开始需要执行的命令*/
        public static String START_EXECUTE = "ls -l /var/android";
        /** first path */
        public static String FIRST_PATH = "/var/android";
        public static String DEFAULT_CHART="UTF-8";
        public static Connection conn = null;
    
        private static String hostname;
    
        private static String username;
    
        private static String password;
    
        @Value("${ssh.hostname}")
        public void setHostname(String name) {
            hostname = name;
        }
    
        @Value("${ssh.username}")
        public void setUsername(String user) {
            username = user;
        }
    
        @Value("${ssh.password}")
        public void setPassword(String pwd) {
            LinuxUtil.password = pwd;
        }
    
        public static boolean login(){
            // 创建远程连接，默认连接端口为22，如果不使用默认，可以使用方法 log.info("主机名:{},用户名:{},密码:{}",hostname,username,password);
            conn = new Connection(hostname);
            try {
                //连接远程服务器
                conn.connect();
                //使用用户名和密码登录
                return conn.authenticateWithPassword(username, password);
            } catch (IOException e) {
                System.err.printf("用户%s密码%s登录服务器%s失败！", "hadoop", "hadoop", "192.168.159.128");
                e.printStackTrace();
            }
            return false;
        }
    
    
        /**
         *
         * @param cmd
         *
         * @return  执行命令 返回结果
         */
        public static String execute(Connection conn, String cmd){
            String result="";
            Session session=null;
            try {
                if(conn !=null){
                    //打开一个会话
                    session= conn.openSession();
                    //执行命令
                    session.execCommand(cmd);
                    result=processStdout(session.getStdout(),DEFAULT_CHART);
                    log.info("执行的命令："+cmd);
                }
                return result;
            } catch (IOException e) {
                log.info("执行命令失败,链接conn:"+conn+",执行的命令："+cmd+"  "+e.getMessage());
                e.printStackTrace();
                return "执行失败";
            }finally {
                if(session!=null){
                    session.close();
                }
            }
        }
    
        /**
         * 执行命令返回的结果(返回结果需要等待所有结果返回完毕才返回)
         * @param in
         * @param charset 编码格式
         * @return
         */
        private static String processStdout(InputStream in, String charset) {
            InputStream stdout = new StreamGobbler(in);
            StringBuffer buffer = new StringBuffer();
            BufferedReader br=null;
            try {
                br = new BufferedReader(new InputStreamReader(stdout, charset));
                String line = null;
                while ((line = br.readLine()) != null) {
                    buffer.append(line + "\n");
                }
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }finally {
                try {
                    if(stdout!=null){
                        stdout.close();
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                try {
                    if(br!=null){
                        br.close();
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            return buffer.toString();
        }
    
        public static List<JenkinsResult> getFolderAndFile(String cmd, String firstPath){
            LinuxUtil.login();
            String result = LinuxUtil.execute(conn, cmd);
            String[] resultArray = result.split("\n");
            String[] newArray = delete(0, resultArray);
            List<JenkinsResult> collect = Arrays.stream(newArray).map(str -> {
                JenkinsResult jenkinsResult = new JenkinsResult();
                // 判断当前行遍历是否是目录级
                boolean flag = str.startsWith("d");
                String fileName = str.substring(str.lastIndexOf(" ") + 1);
                jenkinsResult.setFlag(flag);
                jenkinsResult.setFileName(fileName);
                jenkinsResult.setPath(firstPath + "/" +fileName);
                if (flag){
                    // 如果当前行是目录那么需要继续递归当前方法查找它下面的文件或目录
                    List<JenkinsResult> folderAndFile = getFolderAndFile(cmd + "/" + fileName,jenkinsResult.getPath());
                    jenkinsResult.setChildren(folderAndFile);
                }
                return jenkinsResult;
            }).collect(Collectors.toList());
            return collect;
        }
    
        /**
         *  此方法为了删除数组中第一个元素 重构数组并返回
         */
        public static String[] delete(int index, String[] array) {
            //数组的删除其实就是覆盖前一位
            String[] arrNew = new String[array.length - 1];
            for (int i = 0; i < array.length - 1; i++) {
                if (i < index) {
                    arrNew[i] = array[i];
                } else {
                    arrNew[i] = array[i + 1];
                }
            }
            return arrNew;
        }
    
        public static void main(String[] args) {
            LinuxUtil.hostname = "你的主机名";
            LinuxUtil.username = "登录用户名";
            LinuxUtil.password = "登录用户密码";
            LinuxUtil.login();
            System.out.println(LinuxUtil.execute(conn, START_EXECUTE));
        }
    }

以上呈现的两个知识点：

@Value 注解构造 static 静态变量的问题，如果将 @Value 注解直接放在属性的上面无法生效,如:

@Value("${ssh.hostname}")
    private static String hostname;
    需要在 set 方法上面加上注解才能生效,
    @Value("${ssh.hostname}")
    public static void setHostname(String name) {
    hostname = name;
    }
    如果加上 static 也是不会生效的,正确写法是：
    @Value("${ssh.hostname}")
    public void setHostname(String name) {
    hostname = name;
    }

通过以上 main 方法运行结果如下：

[![alt][]

![80d3b0cf7d3dcbb4a69c4b3eda42be2c.png][]][alt_ _80d3b0cf7d3dcbb4a69c4b3eda42be2c.png] 命令行输出

红色框框是输出的内容,输出的目录和文件有特定标识,目录前面会有 一个 **d** 关键字,输出内容的第一行是总大小,这一行需要被忽略,这是工具类 **public static String\[\] delete(int index, String\[\] array)** 方法起到的作用

**public static List getFolderAndFile(String cmd, String firstPath)** 这个方法是将我们命令所查到的目录和文件整理成一个树形菜单,前端显示的时候需要写入一个接口调用这个方法即可。

接口如下：

@GetMapping("getJenkinsExportFile")
    public R getJenkinsExportFile(){
        List<JenkinsResult> results = LinuxUtil.getFolderAndFile(LinuxUtil.START_EXECUTE, LinuxUtil.FIRST_PATH);
        return R.ok().put("data",results);
    }

需要用到的实体类：

/**
     * @author vnjohn
     * @NAME: JenkinsResult
     * @DATE: 2020/10/29
     */
    @Data
    public class JenkinsResult {
        
        /** 是否目录*/
        private Boolean flag;
        /** 文件名*/
        private String fileName;
        /** 路径*/
        private String path;
        /** 目录下的子文件*/
        private List<JenkinsResult> children;
    }

提供 File 对象 copy 文件方法：

/**
     *  实现文件 copy 功能
     * @param source
     * @param target
     * @throws IOException
     */
    public static void copyFileUsingFileStreams(File source, File target)
            throws IOException {
        
        InputStream input = null;
        OutputStream output = null;
        try {
        
            input = new FileInputStream(source);
            output = new FileOutputStream(target);
            byte[] buf = new byte[1024];
            int bytesRead;
            while ((bytesRead = input.read(buf)) > 0) {
        
                output.write(buf, 0, bytesRead);
            }
        } finally {
        
            input.close();
            output.close();
        }
    }

#### *相关* ####

[alt]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/382558b770e642f28f53fb18bcab2925.png
[80d3b0cf7d3dcbb4a69c4b3eda42be2c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/c90b2db6e9e74ca7ba6118155766669f.png
[alt_ _80d3b0cf7d3dcbb4a69c4b3eda42be2c.png]: https://i0.wp.com/www.vnjohn.com/wp-content/uploads/2020/10/image-3-1024x299.png?ssl=1