Java Main參數解析(Args4j)

最近實現一個工具，Main函數會有很多參數，而且參數類型不同，為了統一解析，網上找到三方工具類Args4j，輕松搞定。

代碼實例如下：

定義解析類：

import java.io.File

import org.kohsuke.args4j.Option
import org.slf4j.LoggerFactory


/**
  * 數據庫報表生成命令行參數定義
  *
  * @author BarryWang create at 2018/6/23 20:21
  * @version 0.0.1
  */
class ArgOptions {
  val logger= LoggerFactory.getLogger(classOf[ArgOptions])

  /**
    * 對象名及查詢SQL腳本對，中間用英文分號":"隔開
    */
  val query = new scala.collection.mutable.ListBuffer[(String, String, String)];
  @Option(name = "-q",
          aliases = Array("-query"),
          metaVar = "<db>:<objectName>:<sql>",
          usage = "對象名及查詢SQL腳本對，中間用英文分號“:”隔開, 例如database:objectName:sql。（String）")
  def setProperty(property: String): Unit = {
    var arr = property.split(":")
    arr.length match {
      case 3 => query.+=((arr(0), arr(1), arr(2)))
      case _ => logger.info("-query 傳入參數格式錯誤, 正確格式: <db>:<objectName>:<sql>")
    }
  }

  /**
    * JXLS Excel模板文件絕對路徑
    */
  @Option(name = "-t",
          aliases = Array("-template"),
          metaVar = "<template file>",
          usage = "JXLS Excel模板文件絕對路徑， 請參考：http://jxls.sourceforge.net/reference/simple_exporter.html。(File)" )
  var template: File = null

  /**
    * Scala腳本文件
    */
  @Option(name = "-s",
          aliases = Array("-script"),
          metaVar = "<scala script file path>",
          usage = "Scala腳本文件， 請參考：http://ammonite.io/#ScalaScripts。(String)")
  var script: String = null

  /**
    * 輸出Excel文件
    */
  @Option(name = "-o",
          aliases = Array("-output"),
    /* required = true,handler = classOf[StringArrayOptionHandler],*/
          metaVar = "<output excel file>",
          usage = "輸出Excel文件絕對路徑。(File)")
  var output: String = null

  /**
    * 輸出Excel文件
    */
  @Option(name = "-m",
    aliases = Array("-mailto"),
    metaVar = "<email>",
    usage = "生成報表發送郵箱，多個使用英文分號“;”分割。(String)")
  var email: String = null


  /**
    * 郵件主題
    */
  @Option(name = "-sub",
    aliases = Array("-subject"),
    metaVar = "<subject>",
    usage = "郵件主題。(String)")
  var subject: String = null
}

 

引用解析類如下：

import java.io.File
import java.util.Date

import com.today.dbreport.action.impl.{GenReportByScriptAction, GenReportBySqlAction, GenReportByTemplateBySqlAction}
import com.today.dbreport.dto.GenReportParam
import com.today.dbreport.utils.EmailUtil
import com.today.service.commons.util.DateTools
import org.kohsuke.args4j.CmdLineParser
import org.slf4j.LoggerFactory

import scala.collection.JavaConverters._

/**
  * 生成報表入口
  *
  * @author BarryWang create at 2018/6/1 11:02
  * @version 0.0.1
  */
object Main {
  val logger= LoggerFactory.getLogger(Main.getClass)

  def main(args: Array[String]): Unit = {
    val options = new ArgOptions
    val parser = new CmdLineParser(options)
    // print usage
    parser.printUsage(System.out)
    parser.parseArgument(args.toList.asJava)

    //輸出文件或發送郵件必填一個
    if(options.output == null && options.email == null){
      println("請傳入參數-output 或 -mailto其中之一")
      return
    }

    //生成報表地址
    var utf8Output = ""
    if (options.output != null) {
        utf8Output = new String(options.output.getBytes("UTF-8"), "UTF-8")
    } else {//本地臨時文件
      val currentTime = DateTools.format(new Date(), "yyyyMMddHHmmssSSS")
      val outDir = s"${System.getProperty("user.dir")}${File.separator}output"
      var outputDir = new File(outDir)
      if(!outputDir.exists()){
        outputDir.mkdirs()
      }
      utf8Output = s"${outDir}${File.separator}${currentTime}.xlsx"
    }
    //帶有Scala腳本
    if (options.script != null) {
      var templateOptional: Option[File] = None
      if (options.template != null) {
        templateOptional = Some(options.template)
      }
      val scriptOptional = Some(options.script)
      var mailtoOptional: Option[String] = None
      if (options.email != null) {
        mailtoOptional = Some(options.email)
      }
      val genReportParam = new GenReportParam(options.query, utf8Output, templateOptional, scriptOptional, mailtoOptional)
      //sql + script + jxls template
      //script + jxls tempalte
      new GenReportByScriptAction(genReportParam).execute
    } else {//無Scala腳本
      var templateOptional: Option[File] = None
      if (options.template != null){
        templateOptional = Some(options.template)
      }
      var scriptOptional : Option[String] = None
      if(options.script != null){
        scriptOptional = Some(options.script)
      }

      var mailtoOptional: Option[String] = None
      if (options.email != null){
        mailtoOptional = Some(options.email)
      }

      val genReportParam = new GenReportParam(options.query, utf8Output, templateOptional, scriptOptional, mailtoOptional)
      if (options.template != null) { //sql* + jxls template
        new GenReportByTemplateBySqlAction(genReportParam).execute
      } else { //no template + sql
        new GenReportBySqlAction(genReportParam).execute
      }
    }

    println(s"報表生成成功${utf8Output}！")
    //發送郵件
    if (options.email != null) {
      var subject = "報表工具生成報表"
      if(options.subject != null){
        subject = options.subject
      }
      EmailUtil.sendEmail(options.email.trim, subject, "生成報表請參考附件", utf8Output)
      println("郵件發送成功，請郵件附件下載相關報表！")
      //郵件發送成功， 刪除本地臨時文件
      if (options.output == null) {
        new File(utf8Output).deleteOnExit()
      }
    }
    logger.info(s"報表生成成功${utf8Output}")
  }
}

運行main函數會展示如下提示：

 -f (-from) <from>                     : 郵件發送者。(String)
 -m (-mailto) <email>                  : 生成報表發送郵箱，多個使用英文分號“;”分割。(String)
 -o (-output) <output excel file>      : 輸出Excel文件絕對路徑。(File)
 -q (-query) <db>:<objectName>:<sql>   : 對象名及查詢SQL腳本對，中間用英文分號“:”隔開,
                                         例如database:objectName:sql。（String）
 -s (-script) <scala script file path> : Scala腳本文件， 請參考：http://ammonite.io/#Scal
                                         aScripts。(String)
 -sub (-subject) <subject>             : 郵件主題。(String)
 -t (-template) <template file>        : JXLS Excel模板文件絕對路徑， 請參考：http://jxls.sou
                                         rceforge.net/reference/simple_exporter.
                                         html。(File)
請傳入參數-output 或 -mailto其中之一

　　

是不是就看起來很直觀了！