Hey there! Let's walk through setting up a remote MySQL data source for your Spring Boot app step by step. I'll cover both the straightforward property file approach (which most folks use) and a custom annotation-based config class if you need more control. Plus, I'll throw in some critical checks to avoid common headaches.

Spring Boot's auto-configuration makes this super simple. You can use either .properties or .yml format—pick whichever fits your project setup.

Option 1: application.properties #

Create or update this file in src/main/resources with your remote DB details:

# Remote MySQL Database Configuration
spring.datasource.url=jdbc:mysql://REMOTE_SERVER_IP:3306/YOUR_DATABASE_NAME?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true
spring.datasource.username=YOUR_DB_USERNAME
spring.datasource.password=YOUR_DB_PASSWORD
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# Optional: Tune HikariCP (Spring Boot's default connection pool)
spring.datasource.hikari.maximum-pool-size=10
spring.datasource.hikari.connection-timeout=30000

Replace REMOTE_SERVER_IP, YOUR_DATABASE_NAME, YOUR_DB_USERNAME, and YOUR_DB_PASSWORD with your actual values.

Option 2: application.yml #

If you prefer YAML syntax:

spring:
  datasource:
    url: jdbc:mysql://REMOTE_SERVER_IP:3306/YOUR_DATABASE_NAME?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true
    username: YOUR_DB_USERNAME
    password: YOUR_DB_PASSWORD
    driver-class-name: com.mysql.cj.jdbc.Driver
    hikari:
      maximum-pool-size: 10
      connection-timeout: 30000

If you need fine-grained control (like multiple data sources, custom pool settings, or overriding auto-config), create a configuration class to define your DataSource bean manually.

Example with HikariDataSource (Recommended) #

HikariCP is Spring Boot's default connection pool for good reason—it's fast and efficient:

import com.zaxxer.hikari.HikariDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class RemoteDataSourceConfig {

    @Value("${spring.datasource.url}")
    private String dbUrl;

    @Value("${spring.datasource.username}")
    private String dbUsername;

    @Value("${spring.datasource.password}")
    private String dbPassword;

    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;

    @Bean
    public DataSource remoteDataSource() {
        HikariDataSource dataSource = new HikariDataSource();
        dataSource.setJdbcUrl(dbUrl);
        dataSource.setUsername(dbUsername);
        dataSource.setPassword(dbPassword);
        dataSource.setDriverClassName(driverClassName);
        
        // Add custom pool settings if needed
        dataSource.setMaximumPoolSize(10);
        dataSource.setConnectionTimeout(30000);
        dataSource.setIdleTimeout(600000);
        
        return dataSource;
    }
}

Cleaner Version with @ConfigurationProperties #

If you want to avoid repeating @Value annotations, use this approach to bind properties directly:

import com.zaxxer.hikari.HikariDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class RemoteDataSourceConfig {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource remoteDataSource() {
        return new HikariDataSource();
    }
}

These are the most common gotchas that trip people up with remote MySQL connections:

• Remote DB Permissions: Log into your MySQL server and grant access to your user from your app's IP (or % for all IPs—use cautiously in production):

  GRANT ALL PRIVILEGES ON YOUR_DATABASE_NAME.* TO 'YOUR_DB_USERNAME'@'%' IDENTIFIED BY 'YOUR_DB_PASSWORD';
  FLUSH PRIVILEGES;
  

• MySQL Bind Address: In your MySQL config file (my.cnf or my.ini), set bind-address = 0.0.0.0 to allow external connections, then restart the MySQL service.
• Server Firewall: Ensure the remote server's firewall allows incoming traffic on port 3306 (MySQL's default port).
• Dependency Check: Make sure you have the MySQL JDBC driver in your build file:
  Maven (pom.xml):

  <dependency>
      <groupId>com.mysql</groupId>
      <artifactId>mysql-connector-j</artifactId>
      <scope>runtime</scope>
  </dependency>
  

  Gradle (build.gradle):

  runtimeOnly 'com.mysql:mysql-connector-j'
  

内容的提问来源于stack exchange，提问作者Nikesh Kedlaya