https://github.com/w3stling/rssreader
A simple Java library for reading RSS and Atom feeds
https://github.com/w3stling/rssreader
atom atom-feed atom-lib atom-library atom-reader feed-reader java java-library lib library rss rss-feed rss-feed-parser rss-lib rss-library rss-parser rss-reader
Last synced: 3 months ago
JSON representation
A simple Java library for reading RSS and Atom feeds
- Host: GitHub
- URL: https://github.com/w3stling/rssreader
- Owner: w3stling
- License: mit
- Created: 2018-06-02T13:57:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-09-11T04:28:02.000Z (4 months ago)
- Last Synced: 2025-09-11T07:56:53.250Z (4 months ago)
- Topics: atom, atom-feed, atom-lib, atom-library, atom-reader, feed-reader, java, java-library, lib, library, rss, rss-feed, rss-feed-parser, rss-lib, rss-library, rss-parser, rss-reader
- Language: Java
- Homepage:
- Size: 3.32 MB
- Stars: 181
- Watchers: 5
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: .github/README-template.md
- License: LICENSE
Awesome Lists containing this project
README
RSS Reader
==========
[](https://github.com/w3stling/rssreader/actions/workflows/build.yml)
[](https://central.sonatype.com/artifact/com.apptasticsoftware/rssreader/%%version%%/overview)
[](https://w3stling.github.io/rssreader/javadoc/%%version%%)
[](http://apptastic-software.mit-license.org)
[](https://github.com/w3stling/rssreader/actions/workflows/codeql-analysis.yml)
[](https://sonarcloud.io/summary/new_code?id=w3stling_rssreader)
[](https://sonarcloud.io/summary/new_code?id=w3stling_rssreader)
[](https://sonarcloud.io/summary/new_code?id=w3stling_rssreader)
[](https://sonarcloud.io/summary/new_code?id=w3stling_rssreader)
[](https://sonarcloud.io/summary/new_code?id=w3stling_rssreader)
> [!NOTE]
> From version 3.0.0:
> * New Java package name
> * New group ID in Maven / Gradle dependency declaration
> * Moved repository from `JCenter` to `Maven Central Repository`
RSS Reader is a simple Java library for reading RSS and Atom feeds. It has zero 3rd party dependencies, a low memory footprint and can process large feeds. Requires at minimum Java 11.
RSS (Rich Site Summary) is a type of web feed which allows users to access updates to online content in a
standardized, computer-readable format. It removes the need for the user to manually
check the website for new content.
Examples
--------
### Read RSS feed
Reads from a RSS (or Atom) feed.
```java
RssReader rssReader = new RssReader();
List items = rssReader.read(URL)
.toList();
```
Extract all items that contains the word football in the title.
```java
RssReader reader = new RssReader();
Stream rssFeed = reader.read(URL);
List footballArticles = rssFeed.filter(i -> i.getTitle().equals(Optional.of("football")))
.toList();
```
### Read feed from a file
Reading from file using InputStream
```java
InputStream inputStream = new FileInputStream("/path/to/file");
List items = new RssReader().read(inputStream);
.toList();
```
Reading from file using file URI
```java
List items = new RssReader().read("file:/path/to/file");
.toList();
```
### Read from multiple feeds
Read from multiple feeds into a single stream of items sorted in descending (newest first) publication date order and prints the title.
```java
List urls = List.of(URL1, URL2, URL3, URL4, URL5);
new RssReader().read(urls)
.sorted()
.map(Item::getTitle)
.forEach(System.out::println);
```
To change sort order to ascending (oldest first) publication date
```java
.sorted(ItemComparator.oldestPublishedItemFirst())
```
For sorting on updated date instead of publication date
```java
.sorted(ItemComparator.newestUpdatedItemFirst())
.sorted(ItemComparator.oldestUpdatedItemFirst())
```
### Podcast / iTunes module
Use iTunes module for extracting data from [Podcast][4] specific tags and attributes.
```java
List items = new ItunesRssReader().read(URL)
.toList();
```
### Custom RSS / Atom feed extensions
Support for mapping custom tags and attributes in feed to item and channel object.
```java
List items = new RssReader()
.addItemExtension("dc:creator", Item::setAuthor)
.addItemExtension("dc:date", Item::setPubDate)
.read("https://lwn.net/headlines/rss")
.toList();
```
Download
--------
Download [the latest JAR][1] or grab via [Maven][2] or [Gradle][3].
### Maven setup
Add dependency declaration:
```xml
...
com.apptasticsoftware
rssreader
%%version%%
...
```
### Gradle setup
Add dependency declaration:
```groovy
dependencies {
implementation 'com.apptasticsoftware:rssreader:%%version%%'
}
```
Markup Validation Services
-------
Useful links for validating feeds
### RSS / Atom
https://validator.w3.org/feed/
https://www.feedvalidator.org/check.cgi
### Podcast / iTunes
https://podba.se/validate/
https://www.castfeedvalidator.com/
License
-------
MIT License
Copyright (c) %%year%%, Apptastic Software
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[1]: https://central.sonatype.com/artifact/com.apptasticsoftware/rssreader/%%version%%/overview
[2]: https://maven.apache.org
[3]: https://gradle.org
[4]: https://help.apple.com/itc/podcasts_connect/#/itcb54353390