質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.91%

SpringBootのEmbeddedTomcatでDataSourceにJNDIを使用したい。

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 2,748

score 21

前提・実現したいこと

  • SpringBootを使用しWebサービスを開発する。DBはPostgreSQLを使用する。
  • DBアクセスする際のDataSourceにJNDIを使用したい。
  • 開発はSpringBootの組み込みTomcatを使用し、本番ではサーバ上のTomcatにwarファイルをデプロイして動作させたい。
  • ORMにはMybatisを使用し、EntityクラスとMapperはMybatisGeneratorで生成したものを使用する。

発生している問題・エラーメッセージ

サーバー上のTomcatにwarファイルをデプロイした場合は正常に動作するが、
組み込みTomcatで動作させる際、DBに問い合わせを行うと下記のエラーが表示される。

※組み込みTomcatを使用しない場合は正常にアクセスできているため、サーバー側のtomcatのcontext.xmlやserver.xmlは正しく設定できていると考えています。

### Error querying database.  Cause: org.springframework.jndi.JndiLookupFailureException: JndiObjectTargetSource failed to obtain new target object; nested exception is javax.naming.NamingException: Could not load resource factory class [Root exception is java.lang.ClassNotFoundException: org.apache.tomcat.jdbc.pool.DataSourceFactory]
### The error may exist in jp/co/example/testserver/mybatis/mapper/generated/TestTableMapper.xml
### The error may involve jp.co.example.testserver.mybatis.mapper.generated.TestTableMapper.selectByPrimaryKey
### The error occurred while executing a query
### Cause: org.springframework.jndi.JndiLookupFailureException: JndiObjectTargetSource failed to obtain new target object; nested exception is javax.naming.NamingException: Could not load resource factory class [Root exception is java.lang.ClassNotFoundException: org.apache.tomcat.jdbc.pool.DataSourceFactory]] with root cause

java.lang.ClassNotFoundException: org.apache.tomcat.jdbc.pool.DataSourceFactory
    at org.springframework.boot.web.embedded.tomcat.TomcatEmbeddedWebappClassLoader.loadClass(TomcatEmbeddedWebappClassLoader.java:68) ~[spring-boot-2.1.7.RELEASE.jar:2.1.7.RELEASE]
    at org.apache.catalina.loader.WebappClassLoaderBase.loadClass(WebappClassLoaderBase.java:1188) ~[tomcat-embed-core-9.0.22.jar:9.0.22]
    at org.apache.naming.factory.FactoryBase.getObjectInstance(FactoryBase.java:61) ~[tomcat-embed-core-9.0.22.jar:9.0.22]
    at javax.naming.spi.NamingManager.getObjectInstance(NamingManager.java:321) ~
(省略)

該当のソースコード

  • pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.7.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <groupId>jp.co.example</groupId>
    <artifactId>test-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>test-server</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.0</version>
        </dependency>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>tomcat-dbcp</artifactId>
            <version>${tomcat.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
            </plugin>
        </plugins>
    </build>

</project>
  • TestServerApplication.java
@SpringBootApplication
@EnableAutoConfiguration
public class TestServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestServerApplication.class, args);
    }

    @Bean
    public TomcatServletWebServerFactory tomcatFactory() {
        return new TomcatServletWebServerFactory() {
            @Override
            protected TomcatWebServer getTomcatWebServer(Tomcat tomcat) {
                tomcat.enableNaming();
                return super.getTomcatWebServer(tomcat);
            }

            @Override
            protected void postProcessContext(Context context) {
                ContextResource resource = new ContextResource();
                resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
                resource.setName("jdbc/__TestDB");
                resource.setType(DataSource.class.getName());
                resource.setProperty("driverClassName", "org.postgresql.Driver");
                resource.setProperty("url", "jdbc:postgresql://***.***.***.***:****/TestDB");
                resource.setProperty("username", "********");
                resource.setProperty("password", "********");
                context.getNamingResources().addResource(resource);
            }
        };
    }

    @Lazy
    @Bean(destroyMethod = "")
    public DataSource jndiDataSource() throws IllegalArgumentException, NamingException {
        JndiObjectFactoryBean bean = new JndiObjectFactoryBean();
        bean.setJndiName("java:comp/env/jdbc/__TestDB");
        bean.setProxyInterface(DataSource.class);
        bean.setLookupOnStartup(false);
        bean.afterPropertiesSet();
        return (DataSource) bean.getObject();
    }

}
  • ApiController.java
@RestController
@RequestMapping("api")
public class ApiController {

    @Autowired
    private TestTableMapper testTableMapper;

    /**
     * 文字列を返す
     * 
     * @return
     * @throws IOException
     */
    @RequestMapping("hello")
    private String hello(HttpServletRequest request, HttpServletResponse response) throws IOException {

        TestTable testTable = testTableMapper.selectByPrimaryKey((long) 1);

        LogUtils.info("api/helloエンドポイントにGetアクセスがありました。");

        return "SpringBoot \"API & DB Access\" Test. 名前=" + testTable.getName();
    }
}
  • application.yml
spring:
    datasource:
        jndi-name: java:comp/env/jdbc/__TestDB

試したこと

下記サイト等を参考にいたしました。

  • <https://kazuhira-r.hatenablog.com/entry/20141227/1419709045>
  • <https://github.com/wilkinsona/spring-boot-sample-tomcat-jndi>
  • <https://www.java4s.com/spring-boot-tutorials/spring-boot-configure-datasource-using-jndi-with-example/>
  • <https://stackoverflow.com/questions/24941829/how-to-create-jndi-context-in-spring-boot-with-embedded-tomcat-container/24944671>
  • <https://codedragon.tistory.com/6657>
  • <https://www.oipapio.com/question-468669>
  • <https://stackoverflow.com/questions/39284947/springboot-jndi-datasource-throws-java-lang-classnotfoundexception-org-apache-t>

下記記述をいろいろと変更してみたりしましたが解決しませんでした。

resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
resource.setProperty("factory", "org.apache.tomcat.dbcp.dbcp.BasicDataSourceFactory");
resource.setProperty("factory", "org.apache.tomcat.dbcp.dbcp2.BasicDataSourceFactory");

補足情報(FW/ツールのバージョンなど)

  • IDE STS 4.2.1
  • PostgreSQL 10.7

不備等ありましたら修正いたしますので何卒よろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • fsk5303

    2019/08/14 00:02

    なるほど、理解いたしました。「そこまでして実現するほどの意味はないよ」ということでしたか。
    開発と本番でJNDIのリソース名を統一しておくことで、ソースコードや設定ファイルの変更をしなくても両方の環境でそれぞれ異なるDBへ接続できるため有意義だと考えているのですが間違いでしたでしょうか。
    そうだとしたら、どのように実現するのが有意義でしたでしょうか...。

    キャンセル

  • asahina1979

    2019/08/14 00:28

    spring boot の場合以下の方式が一般的

    ① アクティブプロファイルによる変更(②か③でプロファイルを設定)
    参考:https://qiita.com/mas0061/items/4dd9c54a6bc69b564a02

    ② 環境変数で設定
    【注意事項】アクティブプロファイルの設定をするのに使う場合があるが、
    こっちで全部を設定すると保守が大変

    ③ 起動オプションによる設定
    【注意事項】アクティブプロファイルの設定をするのに使う場合があるが、
    こっちで全部を設定すると保守が大変

    質問のやり方を否定してるので回答にはしません

    キャンセル

  • fsk5303

    2019/08/14 08:34

    ご助言ありがとうございます。大変参考になります。こちらの手段も視野に入れて検討したいと思います。

    キャンセル

回答 1

check解決した方法

0

PC,IDE共に起動しっぱなしで作業をしていたのですが、IDEを再起動したところエラーが解決いたしました。
お手数おかけいたしました。asahina1979さん、ありがとうございました。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.91%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る