Создавайте великолепные отчеты с JasperReports

 contactbook - app ... - lib - jasperreports - jasperreports-6.1.0.jar ... 

У нас есть все необходимые файлы для JasperReports, поэтому давайте создадим класс для интеграции JasperReports. Создайте файл с именем jasper_report.rb в каталоге lib со следующим кодом:

 Dir.entries("#{Rails.root}/lib/jasperreports").each do |lib| require "jasperreports/#{lib}" if lib =~ /\.jar$/ end require 'java' java_import Java::net::sf::jasperreports::engine::JasperFillManager java_import Java::net::sf::jasperreports::engine::JasperExportManager java_import Java::net.sf.jasperreports.engine.JRResultSetDataSource class JasperReport DIR = "#{Rails.root}/app/reports" def initialize(report, query, params = nil) @model = report @report_params = params @conn = ActiveRecord::Base.connection.jdbc_connection @query = query end def to_pdf stmt = @conn.create_statement @result = JRResultSetDataSource.new(stmt.execute_query(@query)) report_source = "#{DIR}/#{@model}.jasper" raise ArgumentError, "#@model does not exist." unless File.exist?(report_source) params = {} params.merge!(@report_params) if @report_params.present? fill = JasperFillManager.fill_report(report_source, params, @result) pdf = JasperExportManager.export_report_to_pdf(fill) return String.from_java_bytes(pdf) end end 

Давайте посмотрим, что на самом деле делает код. Сначала нам нужны все файлы JasperReports в наш класс, например так:

 Dir.entries("#{Rails.root}/lib/jasperreports").each do |lib| require "jasperreports/#{lib}" if lib =~ /\.jar$/ end 

Добавьте объявления импорта Java для JasperReports:

 require 'java' java_import Java::net::sf::jasperreports::engine::JasperFillManager java_import Java::net::sf::jasperreports::engine::JasperExportManager java_import Java::net.sf.jasperreports.engine.JRResultSetDataSource 

Определите место, где будут храниться все отчеты:

 DIR = "#{Rails.root}/app/reports" 

Добавьте код инициализации в конструктор класса:

 def initialize(report, query, params = nil) @model = report @report_params = params @conn = ActiveRecord::Base.connection.jdbc_connection @query = query end 

В качестве первого шага мы инициализировали все необходимые переменные:

• Имя файла report — report
• SQL-запрос отчета — query
• Любые необязательные параметры для передачи в отчет — params

@conn — это соединение JDBC из пула соединений ActiveRecord, поскольку JasperReports требует соединения JDBC для выполнения запроса.

Наконец, мы добавили метод для заполнения и экспорта отчета в формат PDF:

 def to_pdf stmt = @conn.create_statement @result = JRResultSetDataSource.new(stmt.execute_query(@query)) report_source = "#{DIR}/#{@model}.jasper" raise ArgumentError, "#@model does not exist." unless File.exist?(report_source) params = {} params.merge!(@report_params) if @report_params.present? fill = JasperFillManager.fill_report(report_source, params, @result) pdf = JasperExportManager.export_report_to_pdf(fill) return String.from_java_bytes(pdf) end 

Первым элементом является оператор JDBC stmt = @conn.create_statement , который возвращает JDBC ResultSet путем выполнения @result = JRResultSetDataSource.new(stmt.execute_query(@query)) . Файл отчета ( .jasper ), созданный ранее с использованием JasperStudio, имеет значение report_source . После этого вызовите JasperFillManager.fill_report чтобы заполнить отчет предоставленными ResultSet и параметрами. Наконец, вызовите JasperExportManager.export_report_to_pdf чтобы экспортировать отчет в поток PDF, который возвращается с использованием String.from_java_bytes .

Теперь у нас есть отчет в формате PDF, но у нас пока нет возможности отправить его пользователю. Итак, добавьте небольшой вспомогательный метод в application_controller.rb следующим образом:

 def respond_to_report(name, query, filename, download = false, report_params = nil) @report = JasperReport.new(name, query, report_params) disposition = (download.nil? || download == false) ? 'inline' : 'attachment' send_data @report.to_pdf, :filename => filename, :type => :pdf, :disposition => disposition end 

Этот вспомогательный метод упрощает вызов отчета и отправляет ответ обратно пользователю. Также добавлены параметры для предоставления имени файла, наряду с возможностью disposition чтобы открыть файл в браузере или загрузить его как вложение.

Теперь мы добавим действие в ContactsController который вызывает отчет. Добавьте следующий код в app / controllers / contacts_controller.rb :

 def report respond_to_report('contacts', 'select * from contacts', 'contacts.pdf') end 

Поскольку у нас нет параметров для передачи и мы хотим открыть отчет в браузере, мы пропустили download и report_params из вызова метода.

Обновите route.rb, чтобы добавить новое действие:

 resources :contacts do get :report, on: :collection end 

Добавьте ссылку на отчет в представлении contacts / index.html.erb :

 ... <h1>Listing Contacts</h1> <%= link_to 'Download as PDF', report_contacts_path %> ... 

Запустите сервер и перейдите по адресу http: // localhost: 3000 / contacts . Нажмите «Скачать в формате PDF». Теперь вы должны увидеть файл PDF со всеми контактами в списке.

Завершение

Это был краткий пример того, как интегрировать JasperReports с Rails для создания отчетов без особых усилий. С помощью JasperReports и Rails можно сделать гораздо больше, например, критерии поиска, сложные отчеты, подотчеты и т. Д. Но это для другого учебника.

Я надеюсь, вам понравился этот пост. Ваши комментарии и идеи всегда приветствуются.