Jasperreport的客户端打印

Jasperreport客户端打印


Jasperreport以及配合Ireport工具作为模板报表的开源解决方案，想必大家都非常熟悉了。
Jasperreport可以根据Ireport制作的模板，方便地填入业务数据，去生成包括PDF，HTML等各种格式的报表文件，基本能满足常见的各种需求。而当用在BS框架的应用里如电子商务，我们可能就要面对一个客户端打印的问题。

由于在BS框架中，Jasperreport处理和生成报表的代码都是部署在服务端，势必只能在服务端生成报表文件。在业务上要求客户端打印的时候，我们可以有几种方案，一种就是把报表文件在服务端生成好，通过下载数据流等方式下载到本地，进行打印。这种方式开发模式最简单，但是客户体验度很差。另一种方式考虑把报表文件转成图片或者HTMl等浏览器直接能解析的格是，通过浏览器打开，浏览并打印。这个方案的问题在于，如果进入浏览器菜单触发打印，客户的体验度还是较差；而如果通过页面按钮来实现web打印，要兼容性好的话还得使用ActiveX类的web打印控件，也不够简练。

这里要和大家介绍第三种方案，通过JAVA Applet控件方式来实现Japserreport客户端打印。
JAVA的Applet在BS框架中用的较少，好在Jasperreport的包里已经为我们写好了例子，但是实际开发中还是要面临各种问题，本文对此会一一讲述。

我们来看例子：
Applet方式的原理是本地下载Applet以及Jasperreport applet的JAR包，然后服务端准备好被打印对象，applet通过如servlet的方式获得服务端Jasperreport的打印对象，调用本地的打印接口。

首先applet要放在web访问能看到的目录下，可以直接在webapp的根目录下建一个applets目录，里面放你的applet类。
构建和编译applet的时候，建议单独启一个project，编译好class然后贴到项目里的applets目录里，以免和项目的build path混淆。

参考官方的applet例子：

public class PrinterApplet extends javax.swing.JApplet
{


	/**
	 *
	 */
	private URL url;
	private JasperPrint jasperPrint;


	/** Creates new form AppletViewer */
	public PrinterApplet()
	{
		initComponents();
	}


	/**
	*
	*/
	public void init()
	{
		String strUrl = getParameter("REPORT_URL");
		if (strUrl != null)
		{
			try
			{
				url = new URL(getCodeBase(), strUrl);
			}
			catch (Exception e)
			{
				StringWriter swriter = new StringWriter();
				PrintWriter pwriter = new PrintWriter(swriter);
				e.printStackTrace(pwriter);
				JOptionPane.showMessageDialog(this, swriter.toString());
			}
		}
		else
		{
		JOptionPane.showMessageDialog(this, "Source URL not specified");
		}
	}


	/** This method is called from within the constructor to
	 * initialize the form.
	 * WARNING: Do NOT modify this code. The content of this method is
	 * always regenerated by the Form Editor.
	 */
	private void initComponents() {//GEN-BEGIN:initComponents
		pnlMain = new javax.swing.JPanel();
		btnPrint = new javax.swing.JButton();
		btnView = new javax.swing.JButton();

		btnPrint.setText("Print the report");
		btnPrint.addActionListener(new java.awt.event.ActionListener() {
			public void actionPerformed(java.awt.event.ActionEvent evt) {
				btnPrintActionPerformed(evt);
			}
		});

		pnlMain.add(btnPrint);

		btnView.setText("View the report");
		btnView.addActionListener(new java.awt.event.ActionListener() {
			public void actionPerformed(java.awt.event.ActionEvent evt) {
				btnViewActionPerformed(evt);
			}
		});

		pnlMain.add(btnView);

		getContentPane().add(pnlMain, java.awt.BorderLayout.WEST);

	}//GEN-END:initComponents

	protected void btnViewActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_btnViewActionPerformed
		// Add your handling code here:
		if (url != null)
		{
			try
			{
				if (jasperPrint == null)
				{
					jasperPrint = (JasperPrint)JRLoader.loadObject(url);
				}
				if (jasperPrint != null)
				{
					ViewerFrame viewerFrame = new ViewerFrame(this.getAppletContext(), jasperPrint);
					viewerFrame.show();
				}
				else
				{
					JOptionPane.showMessageDialog(this, "Empty report.");
				}
			}
			catch (Exception e)
			{
				StringWriter swriter = new StringWriter();
				PrintWriter pwriter = new PrintWriter(swriter);
				e.printStackTrace(pwriter);
				JOptionPane.showMessageDialog(this, swriter.toString());
			}
		}
		else
		{
			JOptionPane.showMessageDialog(this, "Source URL not specified");
		}
	}//GEN-LAST:event_btnViewActionPerformed

	protected void btnPrintActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_btnPrintActionPerformed
		// Add your handling code here:
		if (url != null)
		{
			if (jasperPrint == null)
			{
				try
				{
					jasperPrint = (JasperPrint)JRLoader.loadObject(url);
				}
				catch (Exception e)
				{
					StringWriter swriter = new StringWriter();
					PrintWriter pwriter = new PrintWriter(swriter);
					e.printStackTrace(pwriter);
					JOptionPane.showMessageDialog(this, swriter.toString());
				}
			}

			if (jasperPrint != null)
			{				
				final JasperPrint print = jasperPrint;

				Thread thread = new Thread
					(
						new Runnable()
						{
							public void run()
							{
								try 
								{
									JasperPrintManager.printReport(print, true);
								}
								catch (Exception e) 
								{
									StringWriter swriter = new StringWriter();
									PrintWriter pwriter = new PrintWriter(swriter);
									e.printStackTrace(pwriter);
									JOptionPane.showMessageDialog(null, swriter.toString());
								}
							}
						}
					);

				thread.start();

				 // JSObject win = JSObject.getWindow(this);
				 // JSObject doc =(JSObject)win.getMember("document");

                 // doc.eval("alert('123')");
			}
			else
			{
				JOptionPane.showMessageDialog(this, "Empty report.");
			}
		}
		else
		{
			JOptionPane.showMessageDialog(this, "Source URL not specified");
		}
	}//GEN-LAST:event_btnPrintActionPerformed


	// Variables declaration - do not modify//GEN-BEGIN:variables
	private javax.swing.JPanel pnlMain;
	private javax.swing.JButton btnView;
	private javax.swing.JButton btnPrint;
	// End of variables declaration//GEN-END:variables

}

我们看到这个applet加入了两个按钮以及事件Print the report和View the report,applet的代码参考官方的例子已经很清楚了，不用做什么大改。
然后我们要注意，因为PrinterApplet需要调用本地打印的接口，所以牵涉到applet的权限问题，有两种方案，一种是通过更改jre对applet的授权。
如使用appletviewer url方式调试APPLET的话，需要在对应的系统JRE如
C:\Program Files\Java\jre7\lib\security\java.policy 文件中加入
permission java.security.AllPermission;
来进行授权。（系统或用户的JRE具体环境配置可以通过控制面板里的JAVA控制台进行察看，同时APPLET使用了缓存机制，也可以在JAVA控制台对缓存进行清理）。

当然，对于大规模的客户端来说，对每个客户端进行文件修改这样的方式是基本不可行的，
这里我们用了第二种方案，就是对JAR包进行签名。
把编译好的applet class进行打包
jar -cvf print.jar *.class （我打了一个print.jar的包）

创建一个证书
keytool -genkey -validity 1800 -keystore applet.store -alias applet
导出证书文件
keytool -export -keystore applet.store -alias applet -file applet.cer
对jar包进行签名
jarsigner -keystore applet.store jasperreports-applet-4.6.0 .jar applet
jarsigner -keystore applet.store print.jar applet

注意print.jar和jasperreports-applet 的jar 包必须都要签名。

签名以后，jar包里的applet就拥有了操作本地IO设备的权限，当然，这个例子里创建的证书并未获得CA认证，在实际使用中，客户端会出现未受信证书的提示和风险提示，当然这并不影响功能的使用，如果有条件的话可以使用受信证书。

另外要提一点的是，用官方自带例子构建出的jasperreports-applet-4.6.0.jar （测试了4.1的版本，同样的问题）是有BUG的，在net\sf\jasperreports\engine\print 这个目录下少一个JRPrintAWT$1.class 这个内部类，这个类可以在官方例子中同版本的jasperreports.jar包中同名目录中找到，我们需要把它补进去，否则打印时会报一个找不到类的错。


下面我们来看页面。
页面因为各个浏览器对APPLET标签以及OBJECT标签支持程度各异，在开发中还是会碰到一些困难。
我们这里主要针对IE以及FIREFOX做了测试和定制。
如果在客户端环境已经安装了JRE的前提下，直接使用
<APPLET CODE = "PrinterApplet.class" CODEBASE = "applets" ARCHIVE = "print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" WIDTH = "300" HEIGHT = "40">
<PARAM NAME = "REPORT_URL" VALUE ="../servlets/jasperprint">
</APPLET>
这样的写法IE和FF都能认（FF试了最新版本，IE试了6，8，9），但问题是需要对没有安装JRE的客户端指名安装包。
这里又会有一个问题，就是目前JAVA的官网(ORACLE)默认安装的JRE版本是7，而很不幸的是在我的测试中发现Jasperreport 4 （测试了4.1 和4.6 两个版本）的applet打印，在JRE7的环境下，打印中英文混合字符串的时候，会出现叠行错位的BUG，而在JRE6的环境下一切OK，因此我们必须自备一个JRE6的安装包以供客户端下载，来解决JRE7的问题。
IE下的写法：
<OBJECT classid="clsid:8AD9C840-044E-11D1-B3E9-00805F499D93" WIDTH = "300" HEIGHT = "40" codebase="applets/jre-6u35-windows-i586.exe" MAYSCRIPT>
<PARAM NAME = CODE VALUE = "PrinterApplet.class" >
<PARAM NAME = CODEBASE VALUE = "applets" >
<PARAM NAME = ARCHIVE VALUE = "print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" >

<PARAM NAME="type" VALUE="application/x-java-applet;version=1.6.0">
<PARAM NAME="scriptable" VALUE="false">
<PARAM NAME = "REPORT_URL" VALUE ="../servlets/jasperprint">
<comment>
<embed type="application/x-java-applet;version=1.6.0" CODE="PrinterApplet.class" JAVA_CODEBASE="applets" ARCHIVE="print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" scriptable=false pluginspage="applets/jre-6u35-windows-i586.exe" >

<noembed></noembed>
</embed>
</comment>
</OBJECT>

FF下的写法：
<EMBED type="application/x-java-applet;version=1.1.2" CODE = "PrinterApplet.class" CODEBASE = "applets" ARCHIVE = "print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" WIDTH = "300" HEIGHT = "40" REPORT_URL = "../servlets/jasperprint" scriptable=false pluginspage="applets/jre-6u35-windows-i586.exe">
<NOEMBED><XMP>
<APPLET CODE = "PrinterApplet.class" CODEBASE = "applets" ARCHIVE = "print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" WIDTH = "300" HEIGHT = "40" MAYSCRIPT></XMP>
<PARAM NAME = CODE VALUE = "PrinterApplet.class" >
<PARAM NAME = CODEBASE VALUE = "applets" >
<PARAM NAME = ARCHIVE VALUE = "print.jar,jasperreports-applet-4.6.0.jar,commons-logging-1.1.1.jar,commons-collections-2.1.1.jar" >

<PARAM NAME="type" VALUE="application/x-java-applet;version=1.6.0">
<PARAM NAME="scriptable" VALUE="false">
<PARAM NAME = "REPORT_URL" VALUE ="../servlets/jasperprint">


</APPLET>
</NOEMBED>
</EMBED>

在上述标签中，applets/jre-6u35-windows-i586.exe 是我们自己JRE安装包的位置，记得把安装包放好。其他需要注意的是对应的applet的类和jar包位置的问题，本例里该JSP页面和applets 的目录同在根目录下，其他位置的话请自行调整相对路径。REPORT_URL是我们调用的servlet的地址，我们来看例子：

public class JasperPrintServlet extends HttpServlet
{


	/**
	 *
	 */
	public void service(
		HttpServletRequest request,
		HttpServletResponse response
		) throws IOException, ServletException
	{
		ServletContext context = this.getServletConfig().getServletContext();

		File reportFile = new File(context.getRealPath("/reports/WebappReport.jasper"));
		if (!reportFile.exists())
			throw new JRRuntimeException("File WebappReport.jasper not found. The report design must be compiled first.");

		Map parameters = new HashMap();
		parameters.put("ReportTitle", "Address Report");
		parameters.put("BaseDir", reportFile.getParentFile());

		JasperPrint jasperPrint = null;

		try
		{
			JasperReport jasperReport = (JasperReport)JRLoader.loadObject(reportFile.getPath());

			jasperPrint = 
				JasperFillManager.fillReport(
					jasperReport,
					parameters, 
					new WebappDataSource()
					);
		}
		catch (JRException e)
		{
			response.setContentType("text/html");
			PrintWriter out = response.getWriter();
			out.println("<html>");
			out.println("<head>");
			out.println("<title>JasperReports - Web Application Sample</title>");
			out.println("<link rel=\"stylesheet\" type=\"text/css\" href=\"../stylesheet.css\" title=\"Style\">");
			out.println("</head>");

			out.println("<body bgcolor=\"white\">");

			out.println("<span class=\"bnew\">JasperReports encountered this error :</span>");
			out.println("<pre>");

			e.printStackTrace(out);

			out.println("</pre>");

			out.println("</body>");
			out.println("</html>");

			return;
		}

		if (jasperPrint != null)
		{
			response.setContentType("application/octet-stream");
			ServletOutputStream ouputStream = response.getOutputStream();

			ObjectOutputStream oos = new ObjectOutputStream(ouputStream);
			oos.writeObject(jasperPrint);
			oos.flush();
			oos.close();

			ouputStream.flush();
			ouputStream.close();
		}
		else
		{
			response.setContentType("text/html");
			PrintWriter out = response.getWriter();
			out.println("<html>");
			out.println("<head>");
			out.println("<title>JasperReports - Web Application Sample</title>");
			out.println("<link rel=\"stylesheet\" type=\"text/css\" href=\"../stylesheet.css\" title=\"Style\">");
			out.println("</head>");

			out.println("<body bgcolor=\"white\">");

			out.println("<span class=\"bold\">Empty response.</span>");

			out.println("</body>");
			out.println("</html>");
		}
	}


}

可以看出servlet的例子非常简单，就是返回一个JasperPrint的被序列化对象。

到这里整个流程基本就串联起来了，然后对于页面的业务需求来说，有时候我们在页面打印动作的同时，可能还要调用一些其他的JS方法，这就涉及到在applet中调用JS，写法也是非常简单，在之前的applet里我注释了该部分：
JSObject win = JSObject.getWindow(this);
JSObject doc =(JSObject)win.getMember("document");

doc.eval("alert('123')");
eval方法中可以调用页面上写好的js方法。
这里要注意的是需要在applets目录中加入一个jar包：plugin.jar,这个包也不用去别处找，就在JRE自带的lib里 （\jre\lib），贴过来即可。

还有一点就是applet里使用JS的话，在页面控件的标签里一定要加入“MAYSCRIPT”，IE的写法加在OBJECT标签里，FF写在ACTIVE的标签里（前面的例子中已加入，请参考）。

至此，一个完整的Jasperreport客户端打印的例子就完成了，一路的大坑小坑已被我们一一填平，我们可以跑一下。
大功告成.