ОНОВЛЕННЯ на 2019 / вересень / 01:
- Починаючи з Scala 2.13, віддайте перевагу використанню scala.util.Using
- Виправлена помилка, куди
finallyпроковтне оригінал, Exceptionкинутий, tryякщо finallyкод кинувException
Переглянувши всі ці відповіді про те, як легко написати файл у Scala, і деякі з них дуже приємні, у мене було три питання:
- У відповіді Jus12 , використання носіїв для використання хелперного методу є неочевидним для початківців Scala / FP
- Потрібно інкапсулювати помилки нижчого рівня за допомогою
scala.util.Try
- Необхідно показати розробникам Java, які є новими для Scala / FP, як правильно вкладати залежні ресурси, щоб
closeметод виконувався на кожному залежному ресурсі у зворотному порядку - Примітка: закриття залежних ресурсів у зворотному порядку ОСОБЛИВО В СЛУЧАХ ПЕРЕДБАЧЕННЯ - рідко зрозуміла вимога java.lang.AutoCloseableспецифікація , яка має тенденцію приводити до дуже згубним і важко знайти помилки і невдачі часу виконання
Перед початком моя мета - не стислість. Це полегшує розуміння для початківців Scala / FP, як правило, тих, хто походить з Java. У самому кінці я витягну всі шматочки разом, а потім збільшу лаконічність.
По-перше, usingметод повинен бути оновлений для використання Try(знову ж таки, стислість тут не є метою). Він буде перейменований на tryUsingAutoCloseable:
def tryUsingAutoCloseable[A <: AutoCloseable, R]
(instantiateAutoCloseable: () => A) //parameter list 1
(transfer: A => scala.util.Try[R]) //parameter list 2
: scala.util.Try[R] =
Try(instantiateAutoCloseable())
.flatMap(
autoCloseable => {
var optionExceptionTry: Option[Exception] = None
try
transfer(autoCloseable)
catch {
case exceptionTry: Exception =>
optionExceptionTry = Some(exceptionTry)
throw exceptionTry
}
finally
try
autoCloseable.close()
catch {
case exceptionFinally: Exception =>
optionExceptionTry match {
case Some(exceptionTry) =>
exceptionTry.addSuppressed(exceptionFinally)
case None =>
throw exceptionFinally
}
}
}
)
Початок вищевказаного tryUsingAutoCloseableметоду може бути заплутаним, оскільки він, мабуть, має два списки параметрів замість звичайного списку одного параметра. Це називається каррінг. І я не буду деталізувати, як працює закваска або де вона інколи корисна. Виявляється, саме для цього конкретного проблемного простору це правильний інструмент для роботи.
Далі нам потрібно створити метод, tryPrintToFileякий створить (або замінить існуючий) Fileі запишемо a List[String]. Він використовує, FileWriterякий інкапсульований a, BufferedWriterякий, у свою чергу, інкапсульований a PrintWriter. А для підвищення продуктивності визначено розмір буфера за замовчуванням, значно більший за типовий BufferedWriter,defaultBufferSize і присвоюється значення 65536.
Ось код (і знову ж таки, стислість тут не є метою):
val defaultBufferSize: Int = 65536
def tryPrintToFile(
lines: List[String],
location: java.io.File,
bufferSize: Int = defaultBufferSize
): scala.util.Try[Unit] = {
tryUsingAutoCloseable(() => new java.io.FileWriter(location)) { //this open brace is the start of the second curried parameter to the tryUsingAutoCloseable method
fileWriter =>
tryUsingAutoCloseable(() => new java.io.BufferedWriter(fileWriter, bufferSize)) { //this open brace is the start of the second curried parameter to the tryUsingAutoCloseable method
bufferedWriter =>
tryUsingAutoCloseable(() => new java.io.PrintWriter(bufferedWriter)) { //this open brace is the start of the second curried parameter to the tryUsingAutoCloseable method
printWriter =>
scala.util.Try(
lines.foreach(line => printWriter.println(line))
)
}
}
}
}
Вищеописаний tryPrintToFileметод корисний тим, що він бере List[String]як вхід і надсилає його до а File. Давайте тепер створимоtryWriteToFile метод, який бере a Stringі записує його в aFile .
Ось код (і я дозволю вам здогадатися про пріоритет лаконічності тут):
def tryWriteToFile(
content: String,
location: java.io.File,
bufferSize: Int = defaultBufferSize
): scala.util.Try[Unit] = {
tryUsingAutoCloseable(() => new java.io.FileWriter(location)) { //this open brace is the start of the second curried parameter to the tryUsingAutoCloseable method
fileWriter =>
tryUsingAutoCloseable(() => new java.io.BufferedWriter(fileWriter, bufferSize)) { //this open brace is the start of the second curried parameter to the tryUsingAutoCloseable method
bufferedWriter =>
Try(bufferedWriter.write(content))
}
}
}
Нарешті, корисно мати змогу отримати вміст Fileа String. Хоча scala.io.Sourceнадає зручний метод для легкого отримання вмісту файлу File, цей closeметод повинен використовуватися Sourceдля випуску базових ручок JVM та файлової системи. Якщо цього не зробити, то ресурс не буде випущений, поки JVM GC (Garbage Collector) не обійдеться, щоб випустити сам Sourceекземпляр. І навіть тоді є лише слабка гарантія JVM . Для цього нам потрібно друге визначення використовуваного методу, який обробляєfinalize , що GC метод буде викликаний до closeресурсу. Це означає, що клієнт несе відповідальність за явний виклик телефону .close методу, точно так само, як це відповідальність за те, щоб клієнт звертався closeза екземпляромjava.lang.AutoCloseablescala.io.Source
Ось код цього (все ще не стислий):
def tryUsingSource[S <: scala.io.Source, R]
(instantiateSource: () => S)
(transfer: S => scala.util.Try[R])
: scala.util.Try[R] =
Try(instantiateSource())
.flatMap(
source => {
var optionExceptionTry: Option[Exception] = None
try
transfer(source)
catch {
case exceptionTry: Exception =>
optionExceptionTry = Some(exceptionTry)
throw exceptionTry
}
finally
try
source.close()
catch {
case exceptionFinally: Exception =>
optionExceptionTry match {
case Some(exceptionTry) =>
exceptionTry.addSuppressed(exceptionFinally)
case None =>
throw exceptionFinally
}
}
}
)
Ось приклад використання його у надзвичайно простому рідинному потоковому зчитувачі файлів (в даний час використовується для читання файлів з обмеженими вкладками з виводу бази даних):
def tryProcessSource(
file: java.io.File
, parseLine: (String, Int) => List[String] = (line, index) => List(line)
, filterLine: (List[String], Int) => Boolean = (values, index) => true
, retainValues: (List[String], Int) => List[String] = (values, index) => values
, isFirstLineNotHeader: Boolean = false
): scala.util.Try[List[List[String]]] =
tryUsingSource(scala.io.Source.fromFile(file)) {
source =>
scala.util.Try(
( for {
(line, index) <-
source.getLines().buffered.zipWithIndex
values =
parseLine(line, index)
if (index == 0 && !isFirstLineNotHeader) || filterLine(values, index)
retainedValues =
retainValues(values, index)
} yield retainedValues
).toList //must explicitly use toList due to the source.close which will
//occur immediately following execution of this anonymous function
)
)
Оновлена версія вищезгаданої функції була надана у відповідь на різний , але пов'язаний StackOverflow питання .
Тепер, зробивши все це разом із витягнутим імпортом (полегшує вставку в робочий аркуш Scala, присутній як у плагіні Eclipse ScalaIDE, так і в плагіні IntelliJ Scala, щоб було легше скинути вихід на робочий стіл, щоб його було легше вивчити за допомогою текстового редактора), ось як виглядає код (з підвищеною стислістю):
import scala.io.Source
import scala.util.Try
import java.io.{BufferedWriter, FileWriter, File, PrintWriter}
val defaultBufferSize: Int = 65536
def tryUsingAutoCloseable[A <: AutoCloseable, R]
(instantiateAutoCloseable: () => A) //parameter list 1
(transfer: A => scala.util.Try[R]) //parameter list 2
: scala.util.Try[R] =
Try(instantiateAutoCloseable())
.flatMap(
autoCloseable => {
var optionExceptionTry: Option[Exception] = None
try
transfer(autoCloseable)
catch {
case exceptionTry: Exception =>
optionExceptionTry = Some(exceptionTry)
throw exceptionTry
}
finally
try
autoCloseable.close()
catch {
case exceptionFinally: Exception =>
optionExceptionTry match {
case Some(exceptionTry) =>
exceptionTry.addSuppressed(exceptionFinally)
case None =>
throw exceptionFinally
}
}
}
)
def tryUsingSource[S <: scala.io.Source, R]
(instantiateSource: () => S)
(transfer: S => scala.util.Try[R])
: scala.util.Try[R] =
Try(instantiateSource())
.flatMap(
source => {
var optionExceptionTry: Option[Exception] = None
try
transfer(source)
catch {
case exceptionTry: Exception =>
optionExceptionTry = Some(exceptionTry)
throw exceptionTry
}
finally
try
source.close()
catch {
case exceptionFinally: Exception =>
optionExceptionTry match {
case Some(exceptionTry) =>
exceptionTry.addSuppressed(exceptionFinally)
case None =>
throw exceptionFinally
}
}
}
)
def tryPrintToFile(
lines: List[String],
location: File,
bufferSize: Int = defaultBufferSize
): Try[Unit] =
tryUsingAutoCloseable(() => new FileWriter(location)) { fileWriter =>
tryUsingAutoCloseable(() => new BufferedWriter(fileWriter, bufferSize)) { bufferedWriter =>
tryUsingAutoCloseable(() => new PrintWriter(bufferedWriter)) { printWriter =>
Try(lines.foreach(line => printWriter.println(line)))
}
}
}
def tryWriteToFile(
content: String,
location: File,
bufferSize: Int = defaultBufferSize
): Try[Unit] =
tryUsingAutoCloseable(() => new FileWriter(location)) { fileWriter =>
tryUsingAutoCloseable(() => new BufferedWriter(fileWriter, bufferSize)) { bufferedWriter =>
Try(bufferedWriter.write(content))
}
}
def tryProcessSource(
file: File,
parseLine: (String, Int) => List[String] = (line, index) => List(line),
filterLine: (List[String], Int) => Boolean = (values, index) => true,
retainValues: (List[String], Int) => List[String] = (values, index) => values,
isFirstLineNotHeader: Boolean = false
): Try[List[List[String]]] =
tryUsingSource(() => Source.fromFile(file)) { source =>
Try(
( for {
(line, index) <- source.getLines().buffered.zipWithIndex
values = parseLine(line, index)
if (index == 0 && !isFirstLineNotHeader) || filterLine(values, index)
retainedValues = retainValues(values, index)
} yield retainedValues
).toList
)
}
Як новачок Scala / FP, я спалював багато годин (в основному розчарування в голові), заробляючи вищевказані знання та рішення. Я сподіваюся, що це допомагає іншим новачкам Scala / FP швидше перебирати цей конкретний горб.