ОБНОВЛЕНИЕ 2019 / сентябрь / 01:
- Начиная с Scala 2.13, предпочитайте использовать scala.util.Using
- Исправлена ошибка, из-за которой
finallyпроглатывался оригинальный Exceptionброшенный код, tryеслиfinallyException
Изучив все эти ответы о том, как легко написать файл в 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и напишет List[String]. Он использует a, 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метод, который принимает Stringи записывает его в File.
Вот код (и я позволю вам угадать приоритет краткости здесь):
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))
}
}
}
Наконец, полезно иметь возможность извлекать содержимое a Fileкак a String. В то время как scala.io.Sourceпредоставляет удобный метод для простого получения содержимого File, closeметод должен использоваться в, Sourceчтобы выпустить основные JVM и дескрипторы файловой системы. Если этого не сделать, ресурс не будет освобожден, пока JVM GC (Сборщик мусора) не сможет освободить сам Sourceэкземпляр. И даже в этом случае есть только слабая гарантия JVM, что finalizeметод будет вызван GC для closeресурса. Это означает, что ответственность за явный вызов closeметода лежит на клиенте , точно так же, как на клиенте лежит ответственность за получение доступа к closeэкземпляруjava.lang.AutoCloseable, Для этого нам понадобится второе определение метода using, который обрабатывает scala.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 быстрее справиться с этой проблемой.