https://github.com/wingify/vwo-java-sdk-example
Provides a basic demo of how server-side works with VWO Java SDK
https://github.com/wingify/vwo-java-sdk-example
ab-testing java java-sdk murmurhash3 sdk-example server-side server-side-rendering springboot vwo
Last synced: 2 months ago
JSON representation
Provides a basic demo of how server-side works with VWO Java SDK
- Host: GitHub
- URL: https://github.com/wingify/vwo-java-sdk-example
- Owner: wingify
- License: apache-2.0
- Created: 2019-07-30T11:46:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T09:33:08.000Z (over 1 year ago)
- Last Synced: 2025-01-08T18:44:44.711Z (4 months ago)
- Topics: ab-testing, java, java-sdk, murmurhash3, sdk-example, server-side, server-side-rendering, springboot, vwo
- Language: HTML
- Homepage: https://developers.vwo.com/docs/fullstack-overview
- Size: 107 KB
- Stars: 2
- Watchers: 15
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VWO Java SDK Example
[vwo-java-sdk](https://github.com/wingify/vwo-java-sdk) allows you to A/B Test your Website at server-side.
This repository provides a basic demo of how server-side works with VWO Java SDK.
## Requirements
The Java SDK supports:
* Open JDK 8, 11, 12
* Oracle JDK 8, 9, 11, 12
## SDK INSTALLATION
Install dependencies using `mvn install`.
## Documentation
Refer [VWO Official Server-side Documentation](https://developers.vwo.com/reference#fullstack-introduction)
## Scripts
1. Install dependencies
```bash
mvn install
```
2. Update your app with your accountId, sdk-key, campaign-test-key and goal-identifier inside `Config.java`
```java
public class Config {
public static String accountId = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String sdkKey = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String campaignKey = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String goalIdentifier = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String featureRolloutCampaignKey = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String featureTestCampaignKey = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String featureTestGoalIdentifier = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static Object featureTestRevenue = "REPLACE_THIS_WITH_CORRECT_VALUE";
public static String variableKey = "REPLACE_THIS_WITH_CORRECT_VALUE";
}
```
3. Run application
## Basic Usage
**GET SETTING FILE**
Each VWO SDK client corresponds to the settingsFIle representing the current state of the campaign settings, that is, a list of server-side running campaign settings.
Setting File is a pre-requisite for initiating the VWO CLIENT INSTANCE.
```java
String settingsFile = VWO.getSettingsFile(accountId, sdkKey));
```
**INSTANTIATION**
SDK provides a method to instantiate a VWO client as an instance. The method accepts an object to configure the VWO client.
The mandatory parameter for instantiating the SDK is settingsFile.
```java
import com.vwo.VWO;
VWO vwoInstance = VWO.launch(settingsFile).build();
```
The VWO client class needs to be instantiated as an instance that exposes various API methods like activate, getVariation and track.
**USER STORAGE SERVICE**
```java
String settingsFile = VWO.getSettingsFile(accountId, sdkKey);
Storage.User userStorage = return new Storage.User() {
@Override
public Map get(String userId, String campaignName) {
for (Map savedCampaign: campaignStorageArray) {
if (savedCampaign.get("userId").equals(userId) && savedCampaign.get("campaignKey").equals(campaignName)) {
return savedCampaign;
}
}
return null;
}
@Override
public void set(Map map){
campaignStorageArray.add(map);
}
};
VWO vwo = VWO.launch(settingsFile).withUserStorage(userStorage).build();
```
**LOGGER**
JAVA SDK utilizes a logging facade, SL4J (https://www.slf4j.org/) as the logging api layer. If no binding is found on the class path,
then you will see the following logs
```
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
You can get the SDK to log by providing a concrete implementation for SLF4J.
```
What it means is that at runtime, the logging `implementation` (or the logger binding) is missing , so slf4j simply use a "NOP" implementation, which does nothing.
If you need to output JAVA SDK logs, there are different approaches for the same.
SIMPLE IMPLEMENTATION
If there are no implementation in your project , you may provide a simple implementation that does not require any configuration at all.
Add following code to you pom.xml,
```java
org.slf4j
slf4j-simple
1.6.4
```
Now you see logging output on STDOUT with INFO level. This simple logger will default show any INFO level message or higher.
In order to see DEBUG messages, you would need to pass -Dorg.slf4j.simpleLogger.defaultLogLevel=debug or simplelogger.properties file on the classpath
See http://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.html for details
CONCRETE IMPLEMENTATION
sl4j supports various logging framework. Refer here ->https://www.slf4j.org/manual.html
We have provided our example with Logback
If you have logback in your class path, to get console logs add following Appender and Logger in logback for formatted logs.
```java
%cyan(VWO-SDK) [%date] %highlight([%level]) %cyan([%logger{10} %file:%line]) %msg%n
DEBUG
```
```java
new VWOLogger(VWO.Enums.LOGGER_LEVEL.DEBUG.value()) {
@Override
public void trace(String message, Object... params) {
LOGGER.trace(message, params);
}
@Override
public void debug(String message, Object... params) {
LOGGER.debug(message, params);
}
@Override
public void info(String message, Object... params) {
LOGGER.info(message, params);
}
@Override
public void warn(String message, Object... params) {
LOGGER.warn(message, params);
}
@Override
public void error(String message, Object... params) {
LOGGER.error(message, params);
}
};
```
For more appenders, refer [this](https://logback.qos.ch/manual/appenders.html).
## Authors
* Core Contributor & Maintainer - [pntgupta](https://github.com/pntgupta)
* Main Contributor - [sakshimahendruvk](https://github.com/sakshimahendruvk)
* Repo health maintainer - [softvar](https://github.com/softvar)
## Contributing
Please go through our [contributing guidelines](https://github.com/wingify/vwo-java-sdk-example/blob/master/CONTRIBUTING.md)
## Code of Conduct
[Code of Conduct](https://github.com/wingify/vwo-java-sdk-example/blob/master/CODE_OF_CONDUCT.md)
## License
[Apache License, Version 2.0](https://github.com/wingify/vwo-java-sdk-example/blob/master/LICENSE)
Copyright 2019-2021 Wingify Software Pvt. Ltd.