Make a garbage reminder with line-bot-sdk-java

Overview

Use the LINE Messaging API SDK (for Java) (https://github.com/line/line-bot-sdk-java) to send reminders before the garbage collection date.

Concept

• Use Spring's schedule function (cron) to push reminders on specified days / hours
• Compliment if you have finished throwing away the garbage, and encourage you to throw it away if it is not finished ** (important) **

The part that responds to the response is realized by "Webhook", and the part that pushes the reminder is realized by "Messaging API".

environment

• jdk1.8
• Spring Boot
• Heroku

• Separately heroku to create an application, LINE to create a channel, enable webhook, webhook You need to register the url of.

Creating a project

Create a project with "SPRING INITIALIZR". Check "lombok" and "Devtool". Artifact is "garbage-reminder".

Once the download is complete, open it in the IDE.

Add dependency

pom.xml

<dependency>
    <groupId>com.linecorp.bot</groupId>
    <artifactId>line-bot-spring-boot</artifactId>
    <version>1.11.0</version>
</dependency>

Add the LINE Messaging API SDK.

Property

application.properties

line.bot.channelSecret = XXXXX
line.bot.channelToken = XXXXX
line.bot.handler.path = /callback

Set the information of the channel opened on LINE.

Implementation of message push

Use the Confirmation Templates (https://developers.line.me/ja/docs/messaging-api/message-types/#confirm-template) to confirm that the garbage removal is complete.

PushConfirmController

@Slf4j
@RestController
public class PushConfirmController {

    private final LineMessagingClient lineMessagingClient;

    ConfirmService(LineMessagingClient lineMessagingClient) {
        this.lineMessagingClient = lineMessagingClient;
    }

    //Push reminders
    @GetMapping("alarm")
    public void pushAlarm() throws URISyntaxException {

        try {
            BotApiResponse response = lineMessagingClient
                                            .pushMessage(new PushMessage("/*UserId of the person you want to push*/",
                                                         new TemplateMessage("Tomorrow is a burning garbage day!",
                                                                 new ConfirmTemplate("Have you finished dumping garbage?",
                                                                         new MessageAction("Yes", "Yes"),
                                                                         new MessageAction("No", "No")
                                                                 )
                                                         )))
                                            .get();
            log.info("Sent messages: {}", response);
        } catch (InterruptedException | ExecutionException e) {
            throw new RuntimeException(e);
        }
    }
}

It is not necessary to make it a controller, but it is easier to check if you can call it with GET.

Verification

notification

message

Since the response has not been implemented, there is no response yet even if the button is pressed.

Implementation of response

Webhooks can return a response when something is sent, such as a message or stamp. I made it so that "yes" or "no" is returned in the confirmation, so I picked up these two words If "Yes", return "Sassuga!", And if "No", return "Let's throw it away!".

Webhook

@Slf4j
@LineMessageHandler
public class WebhookController {

    //Response when text is sent
    @EventMapping
    public void handleTextMessageEvent(MessageEvent<TextMessageContent> event) throws Exception {

        //Get the entered text
        String text = content.getText();

        switch (text) {
            case "Yes": {
                this.reply(replyToken,
                        new TextMessage("That's right!")
                );
                break;
            }
            case "No": {
                this.reply(replyToken,
                        new TextMessage("Let's throw it away!")
                );
                break;
            }
            default:
                log.info("Returns echo message {}: {}", replyToken, text);
                this.replyText(
                        replyToken,
                        text
                );
                break;
        }
    }
}

Verification

Remarks

response

The example returns text, but you can have multiple messages in an array.

reply

this.reply(replyToken,
            Arrays.asList(
                new StickerMessage("1", "13"),    //stamp
                new TextMessage("That's right!")    //text
            )
);

Environment variable

You can have an environment variable on heroku and refer to its value from the properties file.

application.properties

line.bot.channelSecret = ${LINE_BOT_CHANNEL_SECRET}
line.bot.channelToken = ${LINE_BOT_CHANNEL_TOKEN}
line.bot.handler.path = /callback

Scheduling

Once you get here, all you have to do is push it on time! Use Spring's scheduling function @Scheduled.

ScheduledTask

@Slf4j
@Service
public class ScheduledTaskService {

    private static final SimpleDateFormat sdf = new SimpleDateFormat("HH:mm:ss");

    @Scheduled(cron="/*Description of cron*/", zone = "Asia/Tokyo")
    public void executeAlarm() {
        try {
            //Call the process to push
            pushAlarm();
        } catch (URISyntaxException e) {
            log.error("{}", e);
        }
        log.info("cron executed : " + sdf.format(new Date()));
    }
}

• Don't forget to add @EnableScheduling annotation to the class with main function.

That's all there is to it!

Finally

I think you can have a little fun with the garbage that you tend to forget (´ω` *)

The "kitchen sink" in LINE Messaging API SDK (for Java) was very helpful in making it. At first, the part that pushes the message, I implemented it myself without using the SDK ... w It's easier to write clearly using the SDK.

This time, the alert is only for burning garbage days, but you can expand it to create non-burnable garbage days. You can also increase the number of messages and send random messages or send stamps. Please make an original reminder;)

Source code

https://github.com/aytdm/garbage-reminder-bot/tree/v.1.0 (The message may be in English or a stamp may be displayed, but the basics are the same as what is written here.)