TextAreaで非同期にテキストが表示されない

Question

前提・実現したいこと

マークシート読取りソフトを支援するプログラムをKotlinとJavaFXを用いて作成しています。

実装したい内容は

• PDFファイルをjpeg画像に変換する機能
• CSVファイルを解析し，データの加工をする機能

の２つであり，これらの実装は問題なく動いています。

その中で，進捗状況（ログ）を非同期にTextAreaに表示したいですのですが
ここで期待通りの動作をしません。

発生している問題・エラーメッセージ

コンソールには正常にログが流れており，実装内容も正常に動作しています。
しかし，TextAreaには何も表示されず，エラーログも出ていません。

該当のソースコード

######Main.kt

import javafx.concurrent.Task
import java.util.concurrent.Executors
(略)


fun main(args: Array<String>) {
    Application.launch(MarkAnalyzer::class.java, *args)
}

class MarkAnalyzer : Application() {
    
    override fun start(primaryStage: Stage) {
        
        val root = FXMLLoader.load<Parent>(javaClass.classLoader.getResource("markanalyzer.fxml"))
        
        primaryStage.title = "MarkAnalyzer"
        
        val scene = Scene(root)
        
        primaryStage.scene = scene
        primaryStage.setOnCloseRequest { exitProcess(0) }
        
        // アイコンを指定する
        val iconURI = javaClass.classLoader.getResource(略)
        if (iconURI != null) {
            val iconImage = Image(iconURI.toString())
            primaryStage.icons.add(iconImage)
        }
        
        primaryStage.show()
    }
}

data class Team(
        val id: String,
        val grade : String,
        val classNumber : String,
        val game : String,
        val team : String,
        val player : List<String>
)

class Controller : Initializable {
    
    @FXML
    lateinit var convertButton : Button

    @FXML
    lateinit var analyzeButton : Button
　　（略）

    @FXML
    lateinit var logTextArea : TextArea
       
    private var csvFile = File("")
    private var exportDirectory = File("")
    private var pdffiles : List<File> = listOf()
    
    companion object {
        lateinit var instance : Controller
    }
    
    override fun initialize(location: URL?, resources: ResourceBundle?) {
        instance = this

        ファイル選択ダイアログに関する実装(略)
        
        logTextArea.textProperty().addListener { _, _, _ ->
            logTextArea.scrollTop = Double.MAX_VALUE
        }
    }

    private val service = Executors.newSingleThreadScheduledExecutor()
    
    @FXML
    fun convertPdf() {
        if (pdffiles.isEmpty()) {
            return
        }

        val task: Task<Long> = object : Task<Long>() {
            override fun call(): Long {
                for (file in pdffiles) {
                    val filename = file.name
                    val pdf = PDDocument.load(file)
                    val pdfRenderer = PDFRenderer(pdf)

                    log("$filename を読み込みました")
                    log("$filename は${pdf.pages.count}ページあります")

                    for ((index, page) in pdf.pages.withIndex()) {
                        log("$filename の ${index + 1} ページ目を処理中です")
                        val bim = pdfRenderer.renderImageWithDPI(index, 300f, ImageType.BINARY)

                        if (removalNoiseCheckBox.isSelected) {

                        }

                        ImageIOUtil.writeImage(bim, "${exportFolderLabel.text}\$filename-${index + 1}.jpg", 300)
                    }

                    log("$filename の処理が完了しました")
                    pdf.close()
                }
                
                return 1
            }
        }
        
        task.onFailed = EventHandler { event -> event.source.exception.printStackTrace() }
        task.onSucceeded = EventHandler { println("Done.") }
        
        logTextArea.textProperty().bind(task.messageProperty())
        
        service.execute(task)
    }
    
    @FXML
    fun analyzeCSV() {
        if (!csvFile.exists()) {
            log("エラー　CSVファイルの取得に失敗しました")
            return
        }
        
        val task : Task<Long> = object : Task<Long>() {
            override fun call(): Long {
                val csvAnalyzer = CSVAnalyze(csvFile)
                csvAnalyzer.analyze()
                
                return 1
            }
        }

        task.onFailed = EventHandler { event -> event.source.exception.printStackTrace() }
        task.onSucceeded = EventHandler { println("Done.") }
        
        logTextArea.textProperty().bind(task.messageProperty())
        
        service.execute(task)
    }
    
    private fun applyButtonStatus() {
        convertButton.isDisable = (pdffiles.isEmpty() || !exportDirectory.exists())
        analyzeButton.isDisable = !csvFile.exists()
    }


    fun log(txt: String) {
    	// このprintlnは正常に動作
        println("log called with $txt")
        
        val presentDateTime = LocalDateTime.now()
        val logtext = "[" + presentDateTime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) + "] $txt"
        
        // この内容が反映されない
        logTextArea.appendText(logtext + System.getProperty("line.separator"))
    }
    
}

CSVAnalyzer.kt

import 略

class CSVAnalyze(file: File) {
    
    private val controller = Controller.instance
    
    private var records : List<List<String>>
    
    private var inputCsvFile : File = file

    init {
        controller.log("CSVAnalyze インスタンスが生成されました。")
        
        // 読み込み行のリストを作成する
        val lines = arrayListOf<List<String>>()
        
        controller.log("CSVファイルの読み込みを開始します")
        // CSVファイルを読み込む（Windowsで扱うためShift_JIS）
        inputCsvFile.forEachLine(charset("Shift_JIS")) { 
            if (it.isNotBlank()) {
                lines.add(it.split(','))
            }
        }
        controller.log("${file.name}を読み込みました。")
        
        // 先頭行はタイトル行なので削除する
        // TODO: トグル？
        lines.removeAt(0)
        
        // 変数へ代入
        records = lines
        
        // デバッグ用
        //println(lines)
    }
    
    fun analyze() {
        val teamlist = mutableListOf<Team>()

        // 一行ずつ回していく
        for ((recordindex, line) in records.withIndex()) {
            controller.log("[rowdata: $recordindex]" + line.joinToString(", "))
            val players = arrayListOf<String>()
            
            val id = line[3]
            val grade = line[4].replace("0", "")
            val classNumber = classnumber(line[5])
            val game = line[6]
            val team = line[7]
            
            
            // 列を参照し選手の４ケタ番号を取り出している
            for ((index, value) in line.withIndex()) {
                if (index in 8..25) {
                    if (value.isBlank()) {
                        continue
                    }
                    val onesplace = if (line[index + 18].toInt() == 10) 9 else line[index + 18].toInt() - 1
                    val tensplace = if (value.toInt() == 10) 9 else value.toInt() - 1
                                        
                    if (onesplace == 0 && tensplace == 0) continue
                    
                    val fourdigit = "$grade$classNumber$tensplace$onesplace"
                    players.add(fourdigit)
                }
                players.sort()
            }
            
            controller.log("[${recordindex+1}行目] ${grade}年${classNumber}組 ゲーム($game) チーム($team) プレイヤー${players}")
            
            teamlist.add(Team(id, grade, classNumber, game, team, players))
        }
        
        controller.log("CSVファイルの解析が終了しました。")
        
        val sortedList = teamlist.sortedWith(compareBy({it.game}, {it.grade}, {it.classNumber}, {it.team}))

        controller.log("項目を昇順に並び替えました。")
        controller.log("出力ファイルの生成を開始します。")
                
        val nowtime = LocalDateTime.now().format(DateTimeFormatter.ofPattern("MMdd-hhmmss"))        
        val writeCsvFile = File(inputCsvFile.parent + "/加工後_$nowtime.csv")
        val osw = OutputStreamWriter(FileOutputStream(writeCsvFile), "Shift_JIS")
        val bw = BufferedWriter(osw)
        
        bw.write("連番,学年,クラス,競技,チーム,選手")
        bw.newLine()
        var i = 1
        for (team in sortedList) {
            val sb = StringBuilder()
            
            sb.append(i).append(",").append(team.grade).append(",").append(team.classNumber).append(",").append(team.game).append(",")
                    .append(team.team).append(",")
            i++
            team.player.forEach {
                sb.append(it).append(",")
            }
            bw.write(sb.toString())
            bw.newLine()
        }
        bw.close()
        
        controller.log("ファイルを正常に出力しました。")
    }
}

試したこと

サイトをいくつか参照する中で**～property().bind(他のproperty)**と，他プロパティのバインドを行わなければならないことを知り，
logTextArea.textProperty().bind(task.messageProperty())という実装をしました。

補足情報（FW/ツールのバージョンなど）

開発言語：Kotlin(1.3.50), Java 8

Answer 1

無事解決されたようですが、内容を単純にしたサンプルを作ってみました。参考まで。

import javafx.application.Application
import javafx.application.Platform
import javafx.scene.Scene
import javafx.scene.control.Button
import javafx.scene.control.TextArea
import javafx.scene.layout.GridPane
import javafx.stage.Stage
import java.time.LocalDateTime
import kotlin.concurrent.thread

object xxMessage {
  @JvmStatic
  fun main(args: Array<String>) {
    Application.launch(App::class.java, *args)
  }

  class App : Application() {
    override fun start(stage: Stage) {
      val msgA = TextArea()
      val buttonA = Button("ボタンイベントで処理").also { node ->
        node.setOnAction { ev ->
          node.isDisable = true
          msgA.text = ""
          // 時間のかかる処理
          repeat(5) { index ->
            val msg = "(${index}): ${LocalDateTime.now()}"
            msgA.text += "${msg}\n"
            println("${node.text} // ${msg}")
            Thread.sleep(1000)
          }
          node.isDisable = false
        }
      }

      //
      val msgB = TextArea()
      val buttonB = Button("別スレッドで処理").also { node ->
        node.setOnAction { ev ->
          thread {
            Platform.runLater {
              node.isDisable = true
              msgB.text = ""
            }
            // 時間のかかる処理
            repeat(5) { index ->
              Platform.runLater {
                val msg = "(${index}): ${LocalDateTime.now()}"
                msgB.text += "${msg}\n"
                println("${node.text} // ${msg}")
              }
              Thread.sleep(1000)
            }
            Platform.runLater { node.isDisable = false }
          }
        }
      }

      //
      val gridPane = GridPane().apply {
        add(msgA, 0, 0)
        add(buttonA, 0, 1)
        add(msgB, 1, 0)
        add(buttonB, 1, 1)
      }

      stage.scene = Scene(gridPane)
      stage.title = this.javaClass.name
      stage.show()
    }
  }
}

Answer 2

失礼しました。ちょっと外しましたかもしれません。
処理は別スレッド(Task)で実行されていますね。

logTextArea.textProperty().bind(task.messageProperty())でlogTetAreaとバインドしているmessageProperty()はどこで更新されていますか？その近辺を見直す必要があるのかもしれません。

Comments

[Hinyari_Gohan]

回答ありがとうございます。
省略をしすぎてしまい，さらに読み辛いコードにしてしまいごめんなさい（汗）

ご指摘をいただいたProperty部分の実装を見直し，
https://stackoverflow.com/questions/36250015/javafx-execute-operation-every-x-ms-while-window-is-open/36250491#36250491
のサイトを発見しました。これを参考に実装をしたところ正常に動作しました。

ご指摘，本当にありがとうございました！

Answer 3

analyexx()を実行するタイミングが読み取れないので確かなことは言えませんが、xxボタンのイベントハンドラ内で処理しているのではないでしょうか？

イベントハンドラで重い、時間のかかるような処理は実行せずに、別スレッドで処理しましょう。その別スレッドからlog()メソッド呼び出し、log()メソッドはPlatform#runLator()を使って、TextAreaを更新しましょう。

    fun log(txt: String) {
      Platform.runLator{
        // このprintlnは正常に動作
        println("log called with $txt")
        val presentDateTime = LocalDateTime.now()
        val logtext = "[" + presentDateTime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) + "] $txt"
        // この内容が反映されない
        logTextArea.appendText(logtext + System.getProperty("line.separator"))
      }
    }

see: JavaFXでスレッドを使って描画するときの注意

Answer 4

shiketa さんにご指摘をいただいた，messageProperty について検索を進めるうちに
https://stackoverflow.com/questions/36250015/javafx-execute-operation-every-x-ms-while-window-is-open/36250491#36250491
を発見し，実装したところ正常に動作しました。

class ProgressLog {
private val logText = ReadOnlyStringWrapper()

fun textProperty() : ReadOnlyStringProperty {
return logText
}

private fun getText() : String {
return if(textProperty().get() == null) "" else textProperty().get()
}

fun log(text: String) {
val presentDateTime = LocalDateTime.now()
val formatted = "[" + presentDateTime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")) + "] $text"

println("ProgressLog_log with $text")
logText.set(getText() + "\n" + formatted)
}

よって

logTextArea.textProperty().bind(task.messageProperty())

はコメントアウトし，ProgressLogクラスのインスタンスを生成，logメソッドを呼ぶことで解決しました。