tl;博士
如何告诉 Tomcat 9 使用特定于 Postgres 的 对象工厂来生成DataSource
对象以响应JNDI查询?
细节
通过定义一个与我的上下文名称相同的 XML 文件,我可以轻松地从Apache TomcatDataSource
9 获取对象。例如,对于一个名为 的网络应用程序,我创建了这个文件:clepsydra
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<!-- Domain: DEV, TEST, ACPT, ED, PROD -->
<Environment name = "work.basil.example.deployment-mode"
description = "Signals whether to run this web-app with development, testing, or production settings."
value = "DEV"
type = "java.lang.String"
override = "false"
/>
<Resource
name="jdbc/postgres"
auth="Container"
type="javax.sql.DataSource"
driverClassName="org.postgresql.Driver"
url="jdbc:postgresql://127.0.0.1:5432/mydb"
user="myuser"
password="mypasswd"
/>
</Context>
我将该文件放在我的 Tomcat “基本”文件夹中,在conf
文件夹中,在我使用引擎名称Catalina
和主机名创建的文件夹中localhost
。Tomcat 将设置输入资源工厂以返回DataSource
. 我可以通过 JNDI 访问该实例:
Context ctxInitial = new InitialContext();
DataSource dataSource =
( DataSource ) ctxInitial.lookup( "java:comp/env/jdbc/postgres" )
;
我确实意识到,postgres
在那个查找字符串中可能是特定应用程序更具体的东西。但是,让我们postgres
进行相同的演示。
我要org.postgresql.ds.PGSimpleDataSource
,不要org.apache.tomcat.dbcp.dbcp2.BasicDataSource
此设置使用Tomcat 自己的 JDBC DataSource objects 资源工厂。返回DataSource
类的基础类是org.apache.tomcat.dbcp.dbcp2.BasicDataSource
. 不幸的是,我不想要DataSource
那个班级。我想要一个由The PostgreSQL Global Development Group的JDBC 驱动程序DataSource
提供的类:. org.postgresql.ds.PGSimpleDataSource
通过阅读 Tomcat 文档页面、JNDI Resources How-To和JNDI Datasource How-To,我开始意识到 Tomcat 允许我们为这些DataSource
对象使用替代工厂来代替与 Tomcat 捆绑的默认工厂实现。听起来像我需要的。
PGObjectFactory
我发现 Postgres JDBC 驱动程序已经捆绑了这样的实现:
PGObjectFactory
对于简单的 JDBC 连接。PGXADataSourceFactory
对于支持XA的实现DataSource
,对于分布式事务。
顺便说一句,OSGi 应用程序的驱动程序中内置了一个类似的工厂,PGDataSourceFactory
. 我认为这对我来说对 Tomcat 没有用。
因此,PGObjectFactory
该类实现了javax.naming.spi.ObjectFactory
JNDI 所需的接口。
SPI
我猜spi
在那个包名中的意思是对象工厂通过Java Service Provider Interface (SPI)加载。
因此,我认为需要一个 SPI 映射文件,如Oracle 教程和Vaadin 文档中所述。META-INF
在我的 Vaadin 文件夹中添加了一个文件resources
夹,并在其中创建了一个services
进一步嵌套的文件夹。所以在/resources/META-INF/services
我创建了一个javax.naming.spi.ObjectFactory
包含单行文本的文件,我想要的对象工厂的名称:org.postgresql.ds.common.PGObjectFactory
. 我什至检查了 Postgres JDBC 驱动程序,以物理上验证此类的存在和完全限定名称。
问题
➥ 我的问题是:我如何告诉 Tomcat 使用PGObjectFactory
而不是它的默认对象工厂来生成我的DataSource
对象以生成与我的 Postgres 数据库的连接?
factory
<Resource>
元素上的属性
我曾希望它就像在上面看到的我的元素中添加一个factory
属性 ( )一样简单。我从 Tomcat 页面The Context Container中得到了这个想法。该页面非常混乱,因为它专注于全球资源,但我不需要或不想在全球范围内定义它。我只需要这个用于我的一个网络应用程序。factory="org.postgresql.ds.common.PGObjectFactory"
<Resource>
DataSource
DataSource
添加该factory
属性:
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<!-- Domain: DEV, TEST, ACPT, ED, PROD -->
<Environment name = "work.basil.example.deployment-mode"
description = "Signals whether to run this web-app with development, testing, or production settings."
value = "DEV"
type = "java.lang.String"
override = "false"
/>
<Resource
name="jdbc/postgres"
auth="Container"
type="javax.sql.DataSource"
driverClassName="org.postgresql.Driver"
url="jdbc:postgresql://127.0.0.1:5432/mydb"
user="myuser"
password="mypasswd"
factory="org.postgresql.ds.common.PGObjectFactory"
/>
</Context>
…失败,我的DataSource
对象为空。
ctxInitial = new InitialContext();
DataSource dataSource = ( DataSource ) ctxInitial.lookup( "java:comp/env/jdbc/postgres" );
System.out.println( "dataSource = " + dataSource );
空值
删除该factory="org.postgresql.ds.common.PGObjectFactory"
属性可解决异常。但是后来我又回到了 TomcatBasicDataSource
而不是 Postgres PGSimpleDataSource
。因此我的问题在这里。
我知道我的Context
XML 已成功加载,因为我可以访问Environment
该条目的值。
第二次实验
几天后,我从顶部尝试了这个。
我创建了一个名为“datasource-object-factory”的新“Plain Java Servlet”风格的 Vaadin 14.0.9 项目。
这是我的整个 Vaadin Web 应用程序代码。下半部分是 JNDI 查找。
package work.basil.example;
import com.vaadin.flow.component.ClickEvent;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.notification.Notification;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;
import com.vaadin.flow.server.PWA;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;
/**
* The main view contains a button and a click listener.
*/
@Route ( "" )
@PWA ( name = "Project Base for Vaadin", shortName = "Project Base" )
public class MainView extends VerticalLayout
{
public MainView ( )
{
Button button = new Button( "Click me" ,
event -> Notification.show( "Clicked!" ) );
Button lookupButton = new Button( "BASIL - Lookup DataSource" );
lookupButton.addClickListener( ( ClickEvent < Button > buttonClickEvent ) -> {
Notification.show( "BASIL - Starting lookup." );
System.out.println( "BASIL - Starting lookup." );
this.lookupDataSource();
Notification.show( "BASIL - Completed lookup." );
System.out.println( "BASIL - Completed lookup." );
} );
this.add( button );
this.add( lookupButton );
}
private void lookupDataSource ( )
{
Context ctxInitial = null;
try
{
ctxInitial = new InitialContext();
// Environment entry.
String deploymentMode = ( String ) ctxInitial.lookup( "java:comp/env/work.basil.example.deployment-mode" );
Notification.show( "BASIL - deploymentMode: " + deploymentMode );
System.out.println( "BASIL - deploymentMode = " + deploymentMode );
// DataSource resource entry.
DataSource dataSource = ( DataSource ) ctxInitial.lookup( "java:comp/env/jdbc/postgres" );
Notification.show( "BASIL - dataSource: " + dataSource );
System.out.println( "BASIL - dataSource = " + dataSource );
}
catch ( NamingException e )
{
Notification.show( "BASIL - NamingException: " + e );
System.out.println( "BASIL - NamingException: " + e );
e.printStackTrace();
}
}
}
为简单起见,我没有指定 Tomcat“基本”文件夹,而是使用默认值。我没有从 IntelliJ 运行,而是将我的 Web 应用程序的 WAR 文件手动移动到该webapps
文件夹中。
我下载了 Tomcat 的新版本,版本 9.0.27。我将 Postgres JDBC jar 拖到/lib
文件夹中。我使用 BatChmod 应用程序来设置 Tomcat 文件夹的权限。
对于conf
文件夹,我创建了Catalina
&localhost
文件夹。在那里,我创建了一个文件,其名称datasource-object-factory.xml
与上面看到的内容相同。
<?xml version="1.0" encoding="UTF-8"?>
<Context>
<!-- Domain: DEV, TEST, ACPT, ED, PROD -->
<Environment name = "work.basil.example.deployment-mode"
description = "Signals whether to run this web-app with development, testing, or production settings."
value = "DEV"
type = "java.lang.String"
override = "false"
/>
<Resource
factory="org.postgresql.ds.common.PGObjectFactory"
name="jdbc/postgres"
auth="Container"
type="javax.sql.DataSource"
driverClassName="org.postgresql.Driver"
url="jdbc:postgresql://127.0.0.1:5432/mydb"
user="myuser"
password="mypasswd"
/>
</Context>
我将我的网络应用程序的datasource-object-factory.war
文件复制到webapps
Tomcat 中。最后,我运行 Tomcat/bin/startup.sh
并观察 WAR 文件分解到一个文件夹中。
使用我元素factory="org.postgresql.ds.common.PGObjectFactory"
上的属性,结果是.Resource
DataSource
null
与我的第一个实验一样,我可以访问 的值<Environment>
,因此我知道我的上下文名称 XML 文件正在被找到并通过 JNDI 成功处理。
以下是 Google Drive 上的日志: