Создание электронных отчетов с использованием ксилофона

В сфере ИТ есть задачи, которые выглядят совершенно непривлекательно на фоне успехов в области больших данных, машинного обучения, блокчейна и других модных достижений, но тем не менее остаются актуальными для целой армии разработчиков на протяжении десятилетий. Рассматриваемый случай — это древняя задача формирования и загрузки документов электронных таблиц (в основном MS Excel), с которой сталкивался любой, кто когда-либо писал бизнес-приложения.

Каковы общие параметры для формирования файлов Excel?

1. VBA-макросы. В наши дни идея использования макросов чаще всего неуместна из соображений безопасности.

2. Автоматизация Excel с помощью внешней программы через API. Это требует присутствия Excel на том же компьютере, что и программа, генерирующая отчеты Excel. Этот вариант работал бы в старые добрые времена, клиенты были в основном толстыми и были закодированы как настольное программное обеспечение. Этот вариант никогда не был особенно быстрым или надежным, и вряд ли это вариант в нынешних условиях.

3. Прямая генерация файла XML-Excel. Как мы знаем, Excel поддерживает формат документа XML, который потенциально может быть сгенерирован / изменен любыми средствами поддержки XML. Этот файл может быть сохранен с расширением .xls, хотя, строго говоря, это не файл xls. Excel открывает его без проблем вообще. Этот подход довольно популярен, но отметим один из его недостатков — тот факт, что любое решение, основанное на прямом редактировании формата XML-Excel, является разовым взломом, которому не хватает согласованности.

4. Наконец, генерация файлов Excel возможна с использованием библиотек с открытым исходным кодом, наиболее известным из которых является Apache POI . Разработчики Apache POI приложили большие усилия для реверс-инжиниринга двоичных форматов документов MS Office и много лет поддерживают и развивают эту библиотеку. Результат этого реверс-инжиниринга используется в Open Office для реализации возможности сохранения документов в форматах, совместимых с MS Office, среди прочего.

Я считаю, что последний из вышеупомянутых методов в настоящее время предпочтителен для создания документов, совместимых с MS Office. С одной стороны, он не требует установки какого-либо проприетарного программного обеспечения на сервере, а с другой стороны, он предлагает мощный API, который позволяет использовать все функциональные возможности, предлагаемые MS Office.

Однако есть и недостатки использования Apache POI напрямую. Во-первых, Apache POI — это библиотека Java, и если ваше приложение написано не на одном из языков JVM, вы, вероятно, не сможете его использовать. Во-вторых, это библиотека низкого уровня, которая работает с такими понятиями, как «ячейка», «столбец», «шрифт». Вот почему процедура создания документа с прямым кодированием быстро превращается в раздутый и едва читаемый код, который не делает различий между моделями данных и представлений, трудно изменить и в целом смущает. Прекрасная причина поручить эту задачу наименее опытному разработчику — пусть он возится с этим.

Но все может быть совершенно иначе. LGPL лицензии, Apache POI на основе ксилофон проект основан на идее , с примерно 15-летней историей. В проектах, в которых я принимал участие, он использовался в сочетании с широким спектром платформ и языков, и число разновидностей форм отчетности, которые были произведены с его помощью в самых разных проектах, должно составлять тысячи. Это Java-проект, который может функционировать как утилита командной строки и как библиотека (если ваш код написан на языке JVM, вы можете использовать его как зависимость Maven ).

Ксилофон реализует принцип дифференциации моделей данных и их представления. Данные должны быть сформированы в формате XML (без необходимости беспокоиться о ячейках, шрифтах и ​​разделительных линиях), в то время как Xylophone будет формировать результаты, используя шаблон Excel и дескриптор, который описывает процедуру обхода вашего XML-файла, как показано на схеме:

Шаблон документа (шаблон xls / xlsx) выглядит примерно так:

Как правило, пустой шаблон предоставляется самим клиентом. Заинтересованный клиент будет рад участвовать в создании шаблона: начиная с выбора подходящей формы и вплоть до размеров шрифта и ширины разделительных линий. Преимущество шаблона состоит в том, что небольшие изменения могут быть легко сделаны, когда разработка отчета уже завершена.

Когда работа над «визуальным дизайном» завершена, разработчику остается только:

1. Создайте процедуру вывода необходимых данных в формате XML.

2. Создайте дескриптор, описывающий процедуру обхода вашего XML-файла и копирования фрагментов шаблона в итоговый отчет.

3. Убедитесь, что ячейки ссылаются на элементы XML-файла через выражения XPath.

С выводом XML все более или менее понятно — достаточно выбрать адекватное представление XML данных, необходимых для заполнения формы. Что за дескриптор?

Если бы в создаваемой нами форме не было повторяющихся элементов (например, количество строк в отгрузочных документах, которое отличается от одного к другому), дескриптор будет выглядеть следующим образом:

<element name="root">
    <output range="A1:Z100"/>
</element>

<?xml version="1.0" encoding="UTF-8"?>
<report>
  <column year="2016"/>
  <column year="2017"/>
  <column year="2018"/>
  <item name="Item 1">
    <year amount="365"/>
    <year amount="286"/>
    <year amount="207"/>
  </item>
  <item name="Item 2">
    <year amount="95"/>
    <year amount="606"/>
    <year amount="840"/>
  </item>
  <item name="Item 3">
    <year amount="710"/>
    <year amount="437"/>
    <year amount="100"/>
  </item>
  <totals>
    <year amount="1170"/>
    <year amount="1329"/>
    <year amount="1147"/>
  </totals>
</report>

<?xml version="1.0" encoding="UTF-8"?>
<element name="report">
  <!-- Create a worksheet -->
  <output worksheet="Report" sourcesheet="Sheet1"/>
  <!-- Column headers in left-to-right direction -->
  <iteration mode="horizontal">
    <element name="(before)">
      <!-- Empty cell in top left corner of the table -->
      <output range="A1"/>
    </element>
    <element name="column">
       <output range="B1"/>
    </element>
  </iteration>
  <!-- Rows output: top-to-bottom direction-->
  <iteration mode="vertical">
    <element name="item">
      <!-- Left-to-right inside the row -->
      <iteration mode="horizontal">
        <element name="(before)">
          <!-- Row header -->
          <output range="A2"/>
        </element>
        <!-- After the header, row data in left-to-right direction -->
        <element name="year">
          <output range="B2"/>
        </element>
      </iteration>
    </element>
  </iteration>
  <iteration>
    <element name="totals">
      <iteration mode="horizontal">
        <element name="(before)">
          <!-- Row header -->
          <output range="A3"/>
        </element>
        <!-- After the header, row data in left-to-right direction -->
        <element name="year">
          <output range="B3"/>
        </element>
      </iteration>
    </element>
  </iteration>
</element>

xylophone -data testdata.xml -template template.xlsx -descr descriptor.xml -out report.xlsx

@Grab('ru.curs:xylophone:6.1.10')
import ru.curs.xylophone.XML2Spreadsheet
baseDir = '.'
new File(baseDir, 'testdata.xml').withInputStream {
    input ->
        new File(baseDir, 'report.xlsx').withOutputStream {
            output ->
                XML2Spreadsheet.process(input,
                        new File(baseDir, 'descriptor.xml'),
                        new File(baseDir, 'template.xlsx'),
                        false, output)
        }
}
println 'Done.'